GeoPackage Class

  • GeoPackage
  • class Esri::ArcGISRuntime::GeoPackage

    A GeoPackage file (.gpkg) that can contain multiple datasets of geographic features, non-spatial tabular data, and raster dataset that conform to the OGC GeoPackage format. More...

    Header: #include <GeoPackage.h>
    Since: Esri::ArcGISRuntime 100.2
    Inherits: Esri::ArcGISRuntime::Object and Esri::ArcGISRuntime::Loadable

    Public Functions

    GeoPackage(const QString &path, QObject *parent = nullptr)
    virtual ~GeoPackage() override
    void close()
    QList<Esri::ArcGISRuntime::GeoPackageFeatureTable *> geoPackageFeatureTables() const
    QList<Esri::ArcGISRuntime::GeoPackageRaster *> geoPackageRasters() const
    QString path() const

    Reimplemented Public Functions

    virtual void cancelLoad() override
    virtual void load() override
    virtual Esri::ArcGISRuntime::Error loadError() const override
    virtual Esri::ArcGISRuntime::LoadStatus loadStatus() const override
    virtual void retryLoad() override


    void doneLoading(const Esri::ArcGISRuntime::Error &loadError)
    void loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

    Detailed Description

    A GeoPackage is an open, standards-based, platform-independent, portable, self-describing, compact format for transferring geospatial information. It is a platform-independent SQLite database file that contains the GeoPackage data and metadata tables. See GeoPackage Encoding Standard for more information.

    Member Function Documentation

    [explicit] GeoPackage::GeoPackage(const QString &path, QObject *parent = nullptr)

    Creates a GeoPackage from the GeoPackage file (.gpkg) at the given path.

    • path - Path to a GeoPackage file (.gpkg).
    • parent - The optional parent QObject.

    [override virtual] GeoPackage::~GeoPackage()


    [override virtual] void GeoPackage::cancelLoad()

    Reimplements: Loadable::cancelLoad().

    Cancels loading metadata for the object.

    Cancels loading the metadata if the object is loading.

    See Loadable.

    void GeoPackage::close()

    Closes the GeoPackage.

    Before you close a GeoPackage you should remove all references to the data it contains, such as removing the feature layer from a map and releasing the GeoPackageFeatureTable. Attempts to access a GeoPackage after it is closed will fail, resulting in an error.

    After closing a GeoPackage, the underlying files it references can be deleted or moved.

    [signal] void GeoPackage::doneLoading(const Esri::ArcGISRuntime::Error &loadError)

    Signal emitted when this object is done loading.

    • loadError - Details about any error that may have occurred.

    Note: If there is a load error it will also be emitted on the errorOccurred signal.

    See also Loadable and Object.

    QList<Esri::ArcGISRuntime::GeoPackageFeatureTable *> GeoPackage::geoPackageFeatureTables() const

    Returns the immutable collection of geopackage feature tables contained in the GeoPackage.

    QList<Esri::ArcGISRuntime::GeoPackageRaster *> GeoPackage::geoPackageRasters() const

    Returns the immutable collection of rasters contained in the GeoPackage.

    [override virtual] void GeoPackage::load()

    Reimplements: Loadable::load().

    Loads the metadata for the object asynchronously.

    Loads the metadata if the object is not loaded.

    See Loadable.

    [override virtual] Esri::ArcGISRuntime::Error GeoPackage::loadError() const

    Reimplements: Loadable::loadError() const.

    Returns the load error.

    See Loadable.

    See also Error.

    [override virtual] Esri::ArcGISRuntime::LoadStatus GeoPackage::loadStatus() const

    Reimplements: Loadable::loadStatus() const.

    Returns the load status.

    See Loadable.

    See also LoadStatus.

    [signal] void GeoPackage::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

    Signal emitted when the loadStatus property changes.

    See also Loadable.

    QString GeoPackage::path() const

    The path specified to the GeoPackage file.

    [override virtual] void GeoPackage::retryLoad()

    Reimplements: Loadable::retryLoad().

    Loads or retries loading metadata for the object asynchronously.

    Will retry loading the metadata if the object is failed to load. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded. Will always call the done loading if this is called.

    See Loadable.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.