Skip To Content ArcGIS for Developers Sign In Dashboard

EncCell Class

(Esri::ArcGISRuntime::EncCell)

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

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

Public Functions

EncCell(EncDataset *dataset, QObject *parent = nullptr)
EncCell(const QString &path, QObject *parent = nullptr)
~EncCell()
EncDataset *dataset() const
QString path() const

Reimplemented Public Functions

virtual void cancelLoad()
virtual void load()
virtual Error loadError() const
virtual LoadStatus loadStatus() const
virtual void retryLoad()

Signals

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

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public slot inherited from QObject
  • 1 public variable inherited from QObject
  • 10 static public members inherited from QObject
  • 9 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

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

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(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.

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()

Destructor.

[virtual] void EncCell::cancelLoad()

Reimplemented from Loadable::cancelLoad().

See Loadable.

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.

[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.

[virtual] void EncCell::load()

Reimplemented from Loadable::load().

See Loadable.

[virtual] Error EncCell::loadError() const

Reimplemented from Loadable::loadError().

See Loadable.

[virtual] LoadStatus EncCell::loadStatus() const

Reimplemented from Loadable::loadStatus().

See Loadable.

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

Signal emitted when the load status changes for this object.

See also Loadable.

QString EncCell::path() const

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

[virtual] void EncCell::retryLoad()

Reimplemented from Loadable::retryLoad().

See Loadable.


Feedback on this topic?