Add ENC exchange set

Sample Viewer View Sample on GitHub

Display nautical charts per the ENC specification.

Use case

The ENC specification describes how hydrographic data should be displayed digitally.

An ENC exchange set is a catalog of data files which can be loaded as cells. The cells contain information on how symbols should be displayed in relation to one another, so as to represent information such as depth and obstacles accurately.

How to use the sample

Run the sample and view the ENC data. Pan and zoom around the map. Take note of the high level of detail in the data and the smooth rendering of the layer.

How it works

Specify the path to a local CATALOG.031 file to create an EncExchangeSet.
After loading the exchange set, get the EncDataset objects in the exchange set with datasets().
Create an EncCell for each dataset. Then create an EncLayer for each cell.
Add the ENC layer to a map's operational layers collection to display it.

Relevant API

EncCell
EncDataset
EncExchangeSet
EncLayer

Offline data

Read more about how to set up the sample's offline data here.

Link	Local Location
Exchange Set	`<userhome>`/ArcGIS/Runtime/Data/ENC/ExchangeSetwithoutUpdates
Hydrography	`<userhome>`/ArcGIS/Runtime/Data/ENC/hydrography

Sample Code

import QtQuick 2.6
import QtQuick.Controls 2.2
import Esri.Samples 1.0

Item {

    // add a mapView component
    MapView {
        id: view
        anchors.fill: parent
    }

    // Declare the C++ instance which creates the scene etc. and supply the view
    AddEncExchangeSetSample {
        id: model
        mapView: view
    }
}

#ifdef PCH_BUILD
#include "pch.hpp"
#endif // PCH_BUILD

#include "AddEncExchangeSet.h"

#include "Map.h"
#include "MapQuickView.h"
#include "EncExchangeSet.h"
#include "EncLayer.h"
#include "EncDataset.h"
#include "EncCell.h"
#include "EncEnvironmentSettings.h"
#include "Envelope.h"
#include "GeometryEngine.h"

#include <QDir>
#include <QtCore/qglobal.h>

#ifdef Q_OS_IOS
#include <QStandardPaths>
#endif // Q_OS_IOS

using namespace Esri::ArcGISRuntime;

// helper method to get cross platform data path
namespace
{
  QString defaultDataPath()
  {
    QString dataPath;

  #ifdef Q_OS_ANDROID
    dataPath = "/sdcard";
  #elif defined Q_OS_IOS
    dataPath = QStandardPaths::writableLocation(QStandardPaths::DocumentsLocation);
  #else
    dataPath = QDir::homePath();
  #endif

    return dataPath;
  }
} // namespace

AddEncExchangeSet::AddEncExchangeSet(QObject* parent /* = nullptr */):
  QObject(parent),
  m_map(new Map(Basemap::oceans(this), this))
{
  // set resource path
  EncEnvironmentSettings::setResourcePath(defaultDataPath() + "/ArcGIS/Runtime/Data/ENC/hydrography");

  // create ENC Exchange Set
  QStringList encPaths = { defaultDataPath() + "/ArcGIS/Runtime/Data/ENC/ExchangeSetwithoutUpdates/ENC_ROOT/CATALOG.031" };
  m_encExchangeSet = new EncExchangeSet(encPaths, this);
}

AddEncExchangeSet::~AddEncExchangeSet() = default;

void AddEncExchangeSet::init()
{
  // Register the map view for QML
  qmlRegisterType<MapQuickView>("Esri.Samples", 1, 0, "MapView");
  qmlRegisterType<AddEncExchangeSet>("Esri.Samples", 1, 0, "AddEncExchangeSetSample");
}

MapQuickView* AddEncExchangeSet::mapView() const
{
  return m_mapView;
}

// Set the view (created in QML)
void AddEncExchangeSet::setMapView(MapQuickView* mapView)
{
  if (!mapView || mapView == m_mapView)
    return;

  m_mapView = mapView;
  m_mapView->setMap(m_map);

  // connect to doneLoading signal of EncExchangeSet
  connect(m_encExchangeSet, &EncExchangeSet::doneLoading, this, [this](Error e)
  {
    if (!e.isEmpty())
      return;

    // loop through datasets
    for (EncDataset* dataset : m_encExchangeSet->datasets())
    {
      // create an EncCell from each dataset
      EncCell* cell = new EncCell(dataset, this);

      // create an EncLayer from each cell
      EncLayer* encLayer = new EncLayer(cell, this);

      // connect to the doneLoading signal of the layer
      connect(encLayer, &EncLayer::doneLoading, this, [this, encLayer](Error e)
      {
        if (!e.isEmpty())
          return;

        m_extents << encLayer->fullExtent();

        if (m_extents.length() != m_encExchangeSet->datasets().length())
          return;

        // combine the extents
        Envelope fullExtent = GeometryEngine::combineExtents(m_extents);
        m_mapView->setViewpoint(fullExtent);
      });

      // add the layer to the map
      m_map->operationalLayers()->append(encLayer);
    }
  });

  // load the EncExchangeSet
  m_encExchangeSet->load();

  emit mapViewChanged();
}

#ifndef ADDENCEXCHANGESET_H
#define ADDENCEXCHANGESET_H

namespace Esri
{
namespace ArcGISRuntime
{
class Map;
class MapQuickView;
class EncExchangeSet;
class Geometry;
}
}

#include <QObject>

class AddEncExchangeSet : public QObject
{
  Q_OBJECT

  Q_PROPERTY(Esri::ArcGISRuntime::MapQuickView* mapView READ mapView WRITE setMapView NOTIFY mapViewChanged)

public:
  explicit AddEncExchangeSet(QObject* parent = nullptr);
  ~AddEncExchangeSet();

  static void init();

signals:
  void mapViewChanged();

private:
  Esri::ArcGISRuntime::MapQuickView* mapView() const;
  void setMapView(Esri::ArcGISRuntime::MapQuickView* mapView);

  Esri::ArcGISRuntime::Map* m_map = nullptr;
  Esri::ArcGISRuntime::MapQuickView* m_mapView = nullptr;
  Esri::ArcGISRuntime::EncExchangeSet* m_encExchangeSet = nullptr;
  QList<Esri::ArcGISRuntime::Geometry> m_extents;
};

#endif // ADDENCEXCHANGESET_H

Qt SDK C++ Samples