Add ENC exchange set

View on GitHubSample viewer app

Display nautical charts per the ENC specification.

screenshot

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

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

Relevant API

  • EncCell
  • EncDataset
  • EncExchangeSet
  • EncLayer

Offline data

To set up the sample's offline data, see the Use offline data in the samples section of the Qt Samples repository overview.

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

Tags

data, ENC, hydrographic, layers, maritime, nautical chart

Sample Code

AddEncExchangeSet.cppAddEncExchangeSet.cppAddEncExchangeSet.hAddEncExchangeSet.qml
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
// [WriteFile Name=AddEncExchangeSet, Category=Layers]
// [Legal]
// Copyright 2019 Esri.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// [Legal]

#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 "Error.h"
#include "MapTypes.h"
#include "LayerListModel.h"
#include "Viewpoint.h"

#include <QtCore/qglobal.h>
#include <QFuture>
#include <QStandardPaths>

using namespace Esri::ArcGISRuntime;

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

  #ifdef Q_OS_IOS
    dataPath = QStandardPaths::writableLocation(QStandardPaths::DocumentsLocation);
  #else
    dataPath = QStandardPaths::writableLocation(QStandardPaths::HomeLocation);
  #endif

    return dataPath;
  }
} // namespace

AddEncExchangeSet::AddEncExchangeSet(QObject* parent /* = nullptr */):
  QObject(parent),
  m_map(new Map(BasemapStyle::ArcGISOceans, 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](const Error& e)
  {
    if (!e.isEmpty())
      return;

    // loop through datasets
    const auto datasets = m_encExchangeSet->datasets();
    for (EncDataset* dataset : 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](const 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->setViewpointAsync(Viewpoint{fullExtent});
      });

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

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

  emit mapViewChanged();
}

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