EncLayer Class

  • EncLayer
  • class Esri::ArcGISRuntime::EncLayer

    A layer that displays ENC data. More...

    Header: #include <EncLayer.h>
    Since: Esri::ArcGISRuntime 100.2
    Inherits: Esri::ArcGISRuntime::Layer

    Public Functions

    EncLayer(Esri::ArcGISRuntime::EncCell *encCell, QObject *parent = nullptr)
    virtual ~EncLayer() override
    Esri::ArcGISRuntime::EncCell *cell() const
    void clearSelection() const
    void selectFeature(Esri::ArcGISRuntime::EncFeature *encfeature) const

    Static Public Members

    Esri::ArcGISRuntime::EncEnvironmentSettings *encEnvironmentSettings()

    Detailed Description

    Electronic navigational charts (ENC) are georeferenced vector datasets for the visualization and analysis of hydrographic and maritime information. This API supports ENC that conform to the International Hydrographic Organization (IHO) S-57 standard.

    Functional characteristics

    ENC layer supports identify and selection but does not support query or time. ENC layers cannot be displayed in a scene.

    Performance characteristics

    ENC layers differ from other layer types in that ENC content is cached in an internal collection of SENC files. When an ENC layer is displayed, only the content in the SENC files is referenced. SENC files are produced when an ENC cell is read for the first time and updated as update sets are applied. You can set the path to the SENC storage directory with the EncEnvironmentSettings::sencDataPath property. SENC files are in a binary format that is not intended to be shared between platforms or versions of this API.

    // create ENC Cell using path
    EncCell* encCell = new EncCell(path, parent);
    // visualize ENC data in ENC layer.
    EncLayer* encLayer = new EncLayer(encCell, parent);

    See sample: Add ENC exchange set

    See also Layer, EncCell, LayerContent, and Loadable.

    Member Function Documentation

    [explicit] EncLayer::EncLayer(Esri::ArcGISRuntime::EncCell *encCell, QObject *parent = nullptr)

    Creates a new ENC layer from an ENC cell.

    • encCell - The ENC cell EncCell used as the source of the ENC layer.
    • parent - The optional parent QObject.

    [override virtual] EncLayer::~EncLayer()


    Esri::ArcGISRuntime::EncCell *EncLayer::cell() const

    Returns the ENC cell object associated with the ENC layer.

    Use this method to obtain a reference to the ENC cell held by the layer.

    See also EncCell.

    void EncLayer::clearSelection() const

    Clears / Unselects a previously selected ENC feature (if any).

    See also EncFeature.

    [static] Esri::ArcGISRuntime::EncEnvironmentSettings *EncLayer::encEnvironmentSettings()

    Use this method to obtain a reference to the EncEnvironmentSettings object.

    These settings apply to all ENC layers.

    void EncLayer::selectFeature(Esri::ArcGISRuntime::EncFeature *encfeature) const

    Selects an ENC feature.

    Only a single ENC feature can be selected at a time. Selecting a feature using this method will unselect a previously selected feature.

    • encfeature - The ENC feature to select.

    Only one ENC feature can be selected at a time. Note that some ENC features are rendered as multiple objects on the map - for example, a soundings feature might consist of many individual measurements, each of which will be highlighted when the feature is selected.

    See also EncFeature.

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