Perform valve isolation trace

View inQMLC++
View on GitHub
Sample viewer app

Run a filtered trace to locate operable features that will isolate an area from the flow of network resources.

screenshot

Use case

Determine the set of operable features required to stop a network's resource, effectively isolating an area of the network. For example, you can choose to return only accessible and operable valves: ones that are not paved over or rusted shut.

How to use the sample

Select one or more features to use as filter barriers or create and set the configuration's filter barriers by selecting a category. Check or uncheck 'Include isolated features'. Press 'Trace' to run a subnetwork-based isolation trace. Press 'Reset' to clear filter barriers.

How it works

  1. Create a MapView and connect to its mouseClicked signal.
  2. Create and load a ServiceGeodatabase with a feature service URL and get tables with their layer IDs.
  3. Create a Map that contains FeatureLayer(s) created from the ServiceGeodatabase's tables.
  4. Create and load a UtilityNetwork with the feature service URL and the Map.
  5. Add a GraphicsOverlay with a Graphic that represents the starting location, and another graphics overlay for the filter barriers.
  6. Populate the list of filter barrier categories from UtilityNetworkDefinition::categories.
  7. When the map view is clicked, identify which features are at that location and add a graphic that represents a filter barrier.
  8. Create a UtilityElement for the identified feature and add this utility element to a list of filter barriers.
    • If the element is a junction with more than one terminal, display a terminal picker. Then set the junction's terminal property with the selected terminal.
    • If an edge, set its fractionAlongEdge property using GeometryEngine::fractionAlong.
  9. When "Trace" is pressed:
    • Create UtilityTraceParameters with UtilityTraceType::Isolation and a starting location from a given asset type and global ID.
    • Set the UtilityTraceParameters::traceConfiguration property from a default UtilityTraceConfiguration. Set the filter property with an UtilityTraceFilter object.
  10. If 'Trace' is clicked without filter barriers:
  • Create a new UtilityCategoryComparison with the selected category and UtilityCategoryComparisonOperator::Exists.
  • Create a new UtilityTraceFilter with this condition as Barriers to set Filter and update IncludeIsolatedFeatures properties of the default configuration from step 5.
  • Run UtilityNetwork::trace.
  1. If Trace is clicked with filter barriers:
  • Update IncludeIsolatedFeatures property of the default configuration from step 5.
  • Run UtilityNetwork::trace.
  1. For every FeatureLayer in the map, select the features returned by featuresForElements from the elements matching their NetworkSource::name with the layer's FeatureTable::name.

Relevant API

  • GeometryEngine::fractionAlong
  • ServiceGeodatabase
  • UtilityCategory
  • UtilityCategoryComparison
  • UtilityCategoryComparisonOperator
  • UtilityDomainNetwork
  • UtilityElement
  • UtilityElementTraceResult
  • UtilityNetwork
  • UtilityNetworkDefinition
  • UtilityTerminal
  • UtilityTier
  • UtilityTraceFilter
  • UtilityTraceParameters
  • UtilityTraceResult
  • UtilityTraceType

About the data

The Naperville gas network feature service, hosted on ArcGIS Online (authentication required: this is handled within the sample code), contains a utility network used to run the isolation trace shown in this sample.

Additional information

Using utility network on ArcGIS Enterprise 10.8 requires an ArcGIS Enterprise member account licensed with the Utility Network user type extension. Please refer to the utility network services documentation.

Credentials:

  • Username: viewer01
  • Password: I68VGU^nMurF

Tags

category comparison, condition barriers, filter barriers, isolated features, network analysis, subnetwork trace, trace configuration, trace filter, utility network

Sample Code

PerformValveIsolationTrace.cppPerformValveIsolationTrace.cppPerformValveIsolationTrace.hTerminalPickerView.qmlPerformValveIsolationTrace.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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
// [WriteFile Name=PerformValveIsolationTrace, Category=UtilityNetwork]
// [Legal]
// Copyright 2020 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 "PerformValveIsolationTrace.h"

#include "ArcGISFeatureListModel.h"
#include "FeatureLayer.h"
#include "FeatureQueryResult.h"
#include "Graphic.h"
#include "GraphicsOverlay.h"
#include "Map.h"
#include "MapQuickView.h"
#include "Point.h"
#include "QueryParameters.h"
#include "ServiceFeatureTable.h"
#include "ServiceGeodatabase.h"
#include "SimpleMarkerSymbol.h"
#include "SimpleRenderer.h"
#include "UtilityTraceResultListModel.h"
#include "UtilityAssetGroup.h"
#include "UtilityAssetType.h"
#include "UtilityCategory.h"
#include "UtilityCategoryComparison.h"
#include "UtilityDomainNetwork.h"
#include "UtilityElement.h"
#include "UtilityElementTraceResult.h"
#include "UtilityNetwork.h"
#include "UtilityNetworkDefinition.h"
#include "UtilityNetworkListModel.h"
#include "UtilityNetworkSource.h"
#include "UtilityNetworkTypes.h"
#include "UtilityTerminal.h"
#include "UtilityTerminalConfiguration.h"
#include "UtilityTier.h"
#include "UtilityTraceConfiguration.h"
#include "UtilityTraceFilter.h"
#include "UtilityTraceParameters.h"
#include "GeometryEngine.h"

#include <QUuid>

using namespace Esri::ArcGISRuntime;

namespace
{
const QString featureServiceUrl = QStringLiteral("https://sampleserver7.arcgisonline.com/server/rest/services/UtilityNetwork/NapervilleGas/FeatureServer");
const QString domainNetworkName = QStringLiteral("Pipeline");
const QString tierName = QStringLiteral("Pipe Distribution System");
const QString networkSourceName = QStringLiteral("Gas Device");
const QString assetGroupName = QStringLiteral("Meter");
const QString assetTypeName = QStringLiteral("Customer");
const QString globalId = QStringLiteral("{98A06E95-70BE-43E7-91B7-E34C9D3CB9FF}");
const QString sampleServer7Username = QStringLiteral("viewer01");
const QString sampleServer7Password = QStringLiteral("I68VGU^nMurF");
}

namespace
{
// Convenient RAII template struct that deletes all pointers in a given container.
template <typename T>
struct ScopedCleanup
{
  ScopedCleanup(const QList<T*>& list) : results(list) { }
  ~ScopedCleanup() { qDeleteAll(results); }
  const QList<T*>& results;
};
}

PerformValveIsolationTrace::PerformValveIsolationTrace(QObject* parent /* = nullptr */):
  QObject(parent),
  m_map(new Map(BasemapStyle::ArcGISStreetsNight, this)),
  m_cred(new Credential{sampleServer7Username, sampleServer7Password, this}),
  m_startingLocationOverlay(new GraphicsOverlay(this)),
  m_filterBarriersOverlay(new GraphicsOverlay(this)),
  m_serviceGeodatabase(new ServiceGeodatabase(featureServiceUrl, m_cred, this)),
  m_graphicParent(new QObject())
{
  // disable UI while loading service geodatabase and utility network
  m_tasksRunning = true;

  connect(m_serviceGeodatabase, &ServiceGeodatabase::doneLoading, this, [this](Error error)
  {
    if (m_utilityNetwork->loadStatus() == LoadStatus::Loaded)
    {
      // re-enable UI if both service geodatabase and utility network are loaded
      m_tasksRunning = false;
      emit tasksRunningChanged();
    }

    if (!error.isEmpty())
      return;

    // obtain service feature tables from the service geodatabase
    ServiceFeatureTable* lineLayerTable = m_serviceGeodatabase->table(3);
    ServiceFeatureTable* deviceLayerTable = m_serviceGeodatabase->table(0);

    // create feature layers from the service feature tables
    FeatureLayer* lineLayer = new FeatureLayer(lineLayerTable, this);
    FeatureLayer* deviceLayer = new FeatureLayer(deviceLayerTable, this);

    // add the feature layers to the map
    m_map->operationalLayers()->append(lineLayer);
    m_map->operationalLayers()->append(deviceLayer);
  });
  m_serviceGeodatabase->load();

  // Create and add the utility network to the map before loading
  m_utilityNetwork = new UtilityNetwork(featureServiceUrl, m_map, m_cred, this);
  m_map->utilityNetworks()->append(m_utilityNetwork);

  connectSignals();

  m_utilityNetwork->load();
}

PerformValveIsolationTrace::~PerformValveIsolationTrace() = default;

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

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

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

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

  connect(m_mapView, &MapQuickView::mouseClicked, this, [this](QMouseEvent mouseEvent)
  {
    if (m_map->loadStatus() != LoadStatus::Loaded)
      return;

    constexpr double tolerance = 10.0;
    constexpr bool returnPopups = false;
    m_clickPoint = m_mapView->screenToLocation(mouseEvent.x(), mouseEvent.y());
    m_mapView->identifyLayers(mouseEvent.x(), mouseEvent.y(), tolerance, returnPopups);
  });

  // handle the identify resultss
  connect(m_mapView, &MapQuickView::identifyLayersCompleted, this, &PerformValveIsolationTrace::onIdentifyLayersCompleted);

  // apply renderers
  SimpleMarkerSymbol* startingPointSymbol = new SimpleMarkerSymbol(SimpleMarkerSymbolStyle::Cross, Qt::green, 25, this);
  m_startingLocationOverlay->setRenderer(new SimpleRenderer(startingPointSymbol, this));

  SimpleMarkerSymbol* filterBarrierSymbol = new SimpleMarkerSymbol(SimpleMarkerSymbolStyle::X, Qt::red, 25, this);
  m_filterBarriersOverlay->setRenderer(new SimpleRenderer(filterBarrierSymbol, this));

  m_mapView->graphicsOverlays()->append(m_startingLocationOverlay);
  m_mapView->graphicsOverlays()->append(m_filterBarriersOverlay);

  emit mapViewChanged();
}

QStringList PerformValveIsolationTrace::categoriesList() const
{
  if (!m_utilityNetwork)
    return { };

  if (m_utilityNetwork->loadStatus() != LoadStatus::Loaded)
    return { };

  const QList<UtilityCategory*> categories = m_utilityNetwork->definition()->categories();
  QStringList strList;
  for (UtilityCategory* category : categories)
  {
    strList << category->name();
  }
  return strList;
}

void PerformValveIsolationTrace::performTrace()
{
  if (m_selectedIndex < 0)
    return;

  // disable UI while trace is run
  m_tasksRunning = true;
  emit tasksRunningChanged();

  for (Layer* layer : *m_map->operationalLayers())
  {
    // clear previous selection from the feature layers
    FeatureLayer* featureLayer = dynamic_cast<FeatureLayer*>(layer);
   if (featureLayer)
     featureLayer->clearSelection();
  }

  const QList<UtilityCategory*> categories = m_utilityNetwork->definition()->categories();

  // get the selected utility category
  if (categories[m_selectedIndex] != nullptr)
  {
    // set whether to include isolated features
    m_traceConfiguration->setIncludeIsolatedFeatures(m_isolateFeatures);

    UtilityTraceParameters* traceParameters = new UtilityTraceParameters(UtilityTraceType::Isolation, QList<UtilityElement*> {m_startingLocation}, this);
    traceParameters->setTraceConfiguration(m_traceConfiguration);

    // reset trace configuration filter barriers
    m_traceConfiguration->setFilter(new UtilityTraceFilter(this));

    // set the user selected filter barriers otherwise
    // set the category comparison to the barriers of the configuration's trace filter
    if (!m_filterBarriers.empty())
      traceParameters->setFilterBarriers(m_filterBarriers);
    else
    {
      UtilityCategory* selectedCategory = categories[m_selectedIndex];
      UtilityCategoryComparison* categoryComparison = new UtilityCategoryComparison(selectedCategory, UtilityCategoryComparisonOperator::Exists, this);
      traceParameters->traceConfiguration()->filter()->setBarriers(categoryComparison);
    }
    m_utilityNetwork->trace(traceParameters);
  }
}

void PerformValveIsolationTrace::performReset()
{
  m_filterBarriersOverlay->graphics()->clear();
  m_filterBarriers.clear();
  m_traceConfiguration->setFilter(new UtilityTraceFilter(this));
  m_graphicParent.reset(new QObject());

  for (Layer* layer : *m_map->operationalLayers())
  {
    // clear previous selection from the feature layers
    FeatureLayer* featureLayer = dynamic_cast<FeatureLayer*>(layer);
   if (featureLayer)
     featureLayer->clearSelection();
  }
}

void PerformValveIsolationTrace::connectSignals()
{
  connect(m_utilityNetwork, &UtilityNetwork::doneLoading, this, [this](const Error& error)
  {
    if (m_serviceGeodatabase->loadStatus() == LoadStatus::Loaded)
    {
      // re-enable UI if both service geodatabase and utility network are loaded
      m_tasksRunning = false;
      emit tasksRunningChanged();
    }

    if (!error.isEmpty())
    {
      qDebug() << error.message() << error.additionalMessage();
      return;
    }

    if (m_utilityNetwork->loadStatus() != LoadStatus::Loaded)
      return;

    // get a trace configuration from a tier
    UtilityNetworkDefinition* networkDefinition = m_utilityNetwork->definition();
    UtilityDomainNetwork* domainNetwork = networkDefinition->domainNetwork(domainNetworkName);
    if (domainNetwork)
    {
      UtilityTier* tier = domainNetwork->tier(tierName);
      if (tier)
        m_traceConfiguration = tier->defaultTraceConfiguration();
    }

    if (!m_traceConfiguration)
      return;

    // create a trace filter
    m_traceConfiguration->setFilter(new UtilityTraceFilter(this));

    // get a default starting location
    UtilityNetworkSource* networkSource = networkDefinition->networkSource(networkSourceName);
    if (networkSource)
    {
      UtilityAssetGroup* assetGroup = networkSource->assetGroup(assetGroupName);
      if (assetGroup)
      {
        UtilityAssetType* assetType = assetGroup->assetType(assetTypeName);
        if (assetType)
          m_startingLocation = m_utilityNetwork->createElementWithAssetType(assetType, QUuid(globalId), nullptr, this);
      }
    }

    if (!m_startingLocation)
      return;

    // display starting location
    m_utilityNetwork->featuresForElements(QList<UtilityElement*> {m_startingLocation});

    // populate the combo box choices
    m_categoriesList = categoriesList();
    emit categoriesListChanged();
  });

  connect(m_utilityNetwork, &UtilityNetwork::traceCompleted, this, [this](QUuid)
  {
    // local paret to clean up UtilityElementTraceResult when we leave scope.
    QObject localParent;

    m_tasksRunning = false;
    emit tasksRunningChanged();

    UtilityTraceResultListModel* utilityTraceResultList = m_utilityNetwork->traceResult();

    if (utilityTraceResultList->isEmpty())
    {
      m_noResults = true;
      emit noResultsChanged();
      return;
    }

    UtilityElementTraceResult* utilityElementTraceResult = dynamic_cast<UtilityElementTraceResult*>(utilityTraceResultList->at(0));
    if (utilityElementTraceResult)
    {
      // given local parent to clean up once we leave scope
      utilityElementTraceResult->setParent(&localParent);

      const QList<UtilityElement*> utilityElementList = utilityElementTraceResult->elements(this);

      // A convenience wrapper that deletes the contents of utilityElementList when we leave scope.
      ScopedCleanup<UtilityElement> utilityElementListCleanUp(utilityElementList);

      if (utilityElementList.empty())
      {
        m_noResults = true;
        emit noResultsChanged();
        return;
      }

      // iterate through the map's features
      for (Layer* layer : *m_map->operationalLayers())
      {
        FeatureLayer* featureLayer = dynamic_cast<FeatureLayer*>(layer);
        if (featureLayer)
        {
          // create query parameters to find features whose network source names match layer's feature table name
          QueryParameters queryParameters;
          QList<qint64> objectIds = {};

          for (UtilityElement* utilityElement : utilityElementList)
          {
            const QString networkSourceName = utilityElement->networkSource()->name();
            const QString featureTableName = featureLayer->featureTable()->tableName();
            if (networkSourceName == featureTableName)
              objectIds.append(utilityElement->objectId());
          }
          queryParameters.setObjectIds(objectIds);
          featureLayer->selectFeatures(queryParameters, SelectionMode::New);
        }
      }
    }
  });

  connect(m_utilityNetwork, &UtilityNetwork::featuresForElementsCompleted, this, [this](QUuid)
  {
    // display starting location
    ArcGISFeatureListModel* elementFeaturesList = m_utilityNetwork->featuresForElementsResult();
    const Point startingLocationGeometry = elementFeaturesList->first()->geometry();
    Graphic* graphic = new Graphic(startingLocationGeometry, m_graphicParent.get());
    m_startingLocationOverlay->graphics()->append(graphic);

    constexpr double scale = 3000.0;
    m_mapView->setViewpointCenter(startingLocationGeometry, scale);
    m_tasksRunning = false;
    emit tasksRunningChanged();
  });
}

bool PerformValveIsolationTrace::noResults() const
{
  return m_noResults;
}

bool PerformValveIsolationTrace::tasksRunning() const
{
  return m_tasksRunning;
}

void PerformValveIsolationTrace::onIdentifyLayersCompleted(QUuid, const QList<IdentifyLayerResult*>& results)
{
  // A convenience wrapper that deletes the contents of results when we leave scope.
  ScopedCleanup<IdentifyLayerResult> resultsScopedCleanup(results);

  // could not identify location
  if (results.isEmpty())
    return;

  const IdentifyLayerResult* result = results[0];
  ArcGISFeature* feature = static_cast<ArcGISFeature*>(qAsConst(result)->geoElements()[0]);
  m_element = m_utilityNetwork->createElementWithArcGISFeature(feature);

  const UtilityNetworkSourceType elementSourceType = m_element->networkSource()->sourceType();

  if (elementSourceType == UtilityNetworkSourceType::Junction)
  {
    const QList<UtilityTerminal*> terminals = m_element->assetType()->terminalConfiguration()->terminals();

    if (terminals.size() > 1)
    {
      m_terminals.clear();
      for (UtilityTerminal* terminal : terminals)
      {
        m_terminals.append(terminal->name());
      }
      emit terminalsChanged();
      return;
    }
  }
  else if (elementSourceType == UtilityNetworkSourceType::Edge)
  {
    if (feature->geometry().geometryType() == GeometryType::Polyline)
    {
      const Polyline line = GeometryEngine::removeZ(feature->geometry());
      // Set how far the element is along the edge.
      const double fraction = GeometryEngine::fractionAlong(line, m_clickPoint, -1);
      m_element->setFractionAlongEdge(fraction);
    }
  }

  m_filterBarriersOverlay->graphics()->append(new Graphic(m_clickPoint, m_graphicParent.get()));
  m_filterBarriers.append(m_element);
}

void PerformValveIsolationTrace::selectedTerminal(int index)
{
  UtilityTerminal* selectedTerminal = m_element->assetType()->terminalConfiguration()->terminals().at(index);
  m_element->setTerminal(selectedTerminal);

  m_filterBarriersOverlay->graphics()->append(new Graphic(m_clickPoint, m_graphicParent.get()));
  m_filterBarriers.append(m_element);
}

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