ArcGIS Developers

EncCell Class

class Esri::ArcGISRuntime::EncCell

A single Electronic Navigation Chart (ENC) data source object. More...

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

This class was introduced in Esri::ArcGISRuntime 100.2.

Public Functions

EncCell(const QString &path, QObject *parent = nullptr)
EncCell(Esri::ArcGISRuntime::EncDataset *dataset, QObject *parent = nullptr)
virtual ~EncCell() override
Esri::ArcGISRuntime::EncDataset *dataset() 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(Esri::ArcGISRuntime::Error loadError)
void loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Detailed Description

An ENC cell can be created using a EncDataset obtained from a EncExchangeSet, or using path to S-57/ENC (*.000) file, and can be visualized using EncLayer.

Note: It can take some time to load an ENC cell. Preprocessing the cells by loading them ahead of time is recommended, especially when loading from large ENC exchange sets. Subsequent loads of the cell will read from the internal SENC database for improved performance.

// create ENC Cell using path
EncCell* encCell = new EncCell(path, parent);

// visualize ENC data in ENC layer.
EncLayer* encLayer = new EncLayer(encCell, parent);

See also Loadable and EncLayer.

Member Function Documentation

EncCell::EncCell(const QString &path, QObject *parent = nullptr)

Constructor that takes a path to the S-57/ENC (*.000) file, with an optional parent.

EncCell::EncCell(Esri::ArcGISRuntime::EncDataset *dataset, QObject *parent = nullptr)

Constructor that takes an dataset obtained from a EncExchangeSet, with an optional parent.

Use this method when constructing an ENC cell delivered as part of an exchange set. When an ENC cell is constructed from the path directly, updates (*.001, *.002, etc.) that are part of the associated exchange set (if there is one) will not be applied.

[signal] void EncCell::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 EncCell::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Signal emitted when the load status changes for this object.

See also Loadable.

[override virtual] EncCell::~EncCell()


[override virtual] void EncCell::cancelLoad()

Reimplements: Loadable::cancelLoad().

See Loadable.

Esri::ArcGISRuntime::EncDataset *EncCell::dataset() const

Returns the ENC data set object associated with the ENC cell.

The dataset will be nullptr if the ENC cell was loaded from a path.

See also EncDataset.

[override virtual] void EncCell::load()

Reimplements: Loadable::load().

See Loadable.

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

Reimplements: Loadable::loadError() const.

See Loadable.

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

Reimplements: Loadable::loadStatus() const.

See Loadable.

QString EncCell::path() const

Returns the path to the S-57/ENC (*.000) file associated with the ENC cell.

[override virtual] void EncCell::retryLoad()

Reimplements: Loadable::retryLoad().

See Loadable.

Feedback on this topic?