ArcGIS Developers

EncExchangeSet Class

class Esri::ArcGISRuntime::EncExchangeSet

An Electronic Navigation Chart (ENC) exchange set object. More...

Header: #include <EncExchangeSet>
Since: Esri::ArcGISRuntime 100.2
Inherits: Esri::ArcGISRuntime::Object and Esri::ArcGISRuntime::Loadable

This class was introduced in Esri::ArcGISRuntime 100.2.

Public Functions

EncExchangeSet(const QStringList &paths, QObject *parent = nullptr)
virtual ~EncExchangeSet() override
QList<Esri::ArcGISRuntime::EncDataset *> datasets() const
QStringList paths() const
QString readme() 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(Esri::ArcGISRuntime::Error loadError)
void loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Detailed Description

An exchange set is a package of files that contains one catalog file and at least one S-57 dataset file. An exchange set may be created using the S-57 tools in ArcGIS Desktop's Nautical Toolbox.

// create EncExchangeSet using paths
EncExchangeSet* encExchangeSet = new EncExchangeSet(paths, parent);

// get the list of EncDataset
QList<EncDataset*> EncDatasets = encExchangeSet->datasets();

// display the names of EncDataset
for (EncDataset* EncDataset: EncDatasets)
  qDebug() << EncDataset->name();

See also Loadable and EncLayer.

Member Function Documentation

EncExchangeSet::EncExchangeSet(const QStringList &paths, QObject *parent = nullptr)

Constructor that takes a list of paths with an optional parent.

[signal] void EncExchangeSet::doneLoading(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.

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

Signal emitted when the load status changes for this object.

See also Loadable.

[override virtual] EncExchangeSet::~EncExchangeSet()


[override virtual] void EncExchangeSet::cancelLoad()

Reimplements: Loadable::cancelLoad().

See Loadable.

Subsequent loads of an exchange set and the component data sets will not read the cell information. Instead, Runtime will load the data from the internal SENC database.

QList<Esri::ArcGISRuntime::EncDataset *> EncExchangeSet::datasets() const

Gets the ENC datasets available in the exchange set.

ENC exchange sets consist of one or more datasets and a catalog.

The exchange set's datasets can be used to create EncCell objects, which can be used to create EncLayer objects for display in a map.

[override virtual] void EncExchangeSet::load()

Reimplements: Loadable::load().

See Loadable.

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

Reimplements: Loadable::loadError() const.

See Loadable.

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

Reimplements: Loadable::loadStatus() const.

See Loadable.

QStringList EncExchangeSet::paths() const

Gets the paths of the ENC exchange set.

Note: An ENC exchange set can be loaded with the path to a single exchange set and zero or more update exchange sets.

If an exchange set which only contains updates is loaded, the corresponding exchange set with the base cells must be loaded simultaneously.

QString EncExchangeSet::readme() const

Gets the Readme.txt file path of the ENC exchange set.

[override virtual] void EncExchangeSet::retryLoad()

Reimplements: Loadable::retryLoad().

See Loadable.

Feedback on this topic?