Trace utility network

View on GitHub

Sample viewer app

Discover connected features in a utility network using connected, subnetwork, upstream, and downstream traces.

screenshot

Use case

You can use a trace to visualize and validate the network topology of a utility network for quality assurance. Subnetwork traces are used for validating whether subnetworks, such as circuits or zones, are defined or edited appropriately.

How to use the sample

Tap on one or more features while 'Add starting locations' or 'Add barriers' is selected. When a junction feature is identified, you may be prompted to select a terminal. When an edge feature is identified, the distance from the tapped location to the beginning of the edge feature will be computed. Select the type of trace using the drop down menu. Click 'Trace' to initiate a trace on the network. Click 'Reset' to clear the trace parameters and start over.

How it works

Create a MapView and connect to its mouseClicked signal.
Create and load a ServiceGeodatabase with a feature service URL and get tables by their layer IDs.
Create a Map that contains FeatureLayer(s) created from the ServiceGeodatabase's tables.
Create and load a UtilityNetwork with the same feature service URL as the Map.
Add a GraphicsOverlay with symbology that distinguishes starting locations from barriers.
Identify features on the map and add a Graphic that represents its purpose (starting point or barrier) at the location of each identified feature.
Create a UtilityElement for the identified feature.
Determine the type of this element using its NetworkSource::SourceType property.
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.
Add this UtilityElement to a collection of starting locations or barriers.
Create UtilityTraceParameters with the selected trace type along with the collected starting locations and barriers (if applicable).
Set the UtilityTraceParameters::traceConfiguration with the utility tier's traceConfiguration property.
Run a UtilityNetwork::traceAsync with the specified parameters.
For every FeatureLayer in the map, select the features using the UtilityElement::objectId from the filtered list of UtilityElementTraceResult::elements.

Relevant API

GeometryEngine::fractionAlong
ServiceGeodatabase
UtilityAssetType
UtilityDomainNetwork
UtilityElement
UtilityElementTraceResult
UtilityNetwork
UtilityNetworkDefinition
UtilityNetworkSource
UtilityTerminal
UtilityTier
UtilityTraceConfiguration
UtilityTraceParameters
UtilityTraceResult
UtilityTraceType
UtilityTraversability

About the data

The Naperville electrical network feature service, hosted on ArcGIS Online (authentication required: this is handled within the sample code), contains a utility network used to run the subnetwork-based 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

Sample Code

TraceUtilityNetwork.cpp

TraceUtilityNetwork.h

TraceUtilityNetwork.qml

Use dark colors for code blocksCopy
// [WriteFile Name=TraceUtilityNetwork, Category=UtilityNetwork]
// [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

// sample headers
#include "TraceUtilityNetwork.h"

// ArcGIS Maps SDK headers
#include "ArcGISFeature.h"
#include "AttributeListModel.h"
#include "Credential.h"
#include "Envelope.h"
#include "Error.h"
#include "ErrorException.h"
#include "FeatureLayer.h"
#include "FeatureQueryResult.h"
#include "GeometryEngine.h"
#include "Graphic.h"
#include "GraphicListModel.h"
#include "GraphicsOverlay.h"
#include "GraphicsOverlayListModel.h"
#include "IdentifyLayerResult.h"
#include "LayerListModel.h"
#include "Map.h"
#include "MapQuickView.h"
#include "MapTypes.h"
#include "Polyline.h"
#include "QueryParameters.h"
#include "ServiceFeatureTable.h"
#include "ServiceGeodatabase.h"
#include "SimpleLineSymbol.h"
#include "SimpleMarkerSymbol.h"
#include "SpatialReference.h"
#include "SymbolTypes.h"
#include "UniqueValue.h"
#include "UniqueValueListModel.h"
#include "UniqueValueRenderer.h"
#include "UtilityAssetGroup.h"
#include "UtilityAssetType.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 "UtilityTerminalConfiguration.h"
#include "UtilityTier.h"
#include "UtilityTraceParameters.h"
#include "UtilityTraceResultListModel.h"
#include "Viewpoint.h"

// Qt headers
#include <QFuture>

// Other headers
#include "TaskCanceler.h"

using namespace Esri::ArcGISRuntime;

TraceUtilityNetwork::TraceUtilityNetwork(QObject* parent /* = nullptr */):
  QObject(parent),
  m_map(new Map(BasemapStyle::ArcGISStreetsNight, this)),
  m_cred(new Credential("viewer01", "I68VGU^nMurF", this)),
  m_startingSymbol(new SimpleMarkerSymbol(SimpleMarkerSymbolStyle::Cross, QColor(Qt::green), 20, this)),
  m_barrierSymbol(new SimpleMarkerSymbol(SimpleMarkerSymbolStyle::X, QColor(Qt::red), 20, this)),
  m_mediumVoltageSymbol(new SimpleLineSymbol(SimpleLineSymbolStyle::Solid, QColor(Qt::darkCyan), 3, this)),
  m_lowVoltageSymbol(new SimpleLineSymbol(SimpleLineSymbolStyle::Dash, QColor(Qt::darkCyan), 3, this)),
  m_serviceGeodatabase(new ServiceGeodatabase(m_serviceUrl, m_cred, this)),
  m_graphicParent(new QObject()),
  m_taskCanceler(std::make_unique<TaskCanceler>())
{
  m_map->setInitialViewpoint(Viewpoint(Envelope(-9813547.35557238, 5129980.36635111, -9813185.0602376, 5130215.41254146, SpatialReference::webMercator())));

  connect(m_serviceGeodatabase, &ServiceGeodatabase::doneLoading, this, &TraceUtilityNetwork::createFeatureLayers);

  m_serviceGeodatabase->load();

  connect(m_map, &Map::doneLoading, this, &TraceUtilityNetwork::loadUtilityNetwork);
}

void TraceUtilityNetwork::createFeatureLayers(const Error& error)
{
  if (hasErrorOccurred(error))
    return;

  // Create feature table from the 1st table (index = 0) in the serviceGeodatabase
  m_deviceFeatureTable = m_serviceGeodatabase->table(0);
  m_deviceLayer = new FeatureLayer(m_deviceFeatureTable, this);

  // Create feature table from the 4th table (index = 3) in the serviceGeodatabase
  m_lineFeatureTable = m_serviceGeodatabase->table(3);
  m_lineLayer = new FeatureLayer(m_lineFeatureTable, this);

  m_map->operationalLayers()->append(m_lineLayer);
  m_map->operationalLayers()->append(m_deviceLayer);

  createRenderers();
}

void TraceUtilityNetwork::createRenderers()
{
  // create unique renderer
  m_uniqueValueRenderer = new UniqueValueRenderer(this);
  m_uniqueValueRenderer->setFieldNames(QStringList("ASSETGROUP"));
  UniqueValue* mediumVoltageUniqueValue = createUniqueValue(QString("Medium Voltage"), m_mediumVoltageSymbol, 5);
  UniqueValue* lowVoltageUniqueValue = createUniqueValue(QString("Low Voltage"), m_lowVoltageSymbol, 3);

  // append to UniqueValueRenderer
  m_uniqueValueRenderer->uniqueValues()->append(mediumVoltageUniqueValue);
  m_uniqueValueRenderer->uniqueValues()->append(lowVoltageUniqueValue);

  // set unique value renderer to the line layer
  m_lineLayer->setRenderer(m_uniqueValueRenderer);
}

void TraceUtilityNetwork::loadUtilityNetwork(const Error& error)
{
  if (hasErrorOccurred(error))
    return;

  // Create graphics overlay and append to mapview
  m_graphicsOverlay = new GraphicsOverlay(this);
  m_mapView->graphicsOverlays()->append(m_graphicsOverlay);

  m_utilityNetwork = new UtilityNetwork(m_serviceUrl, m_map, m_cred, this);

  connect(m_utilityNetwork, &UtilityNetwork::errorOccurred, this, &TraceUtilityNetwork::hasErrorOccurred);

  connect(m_utilityNetwork, &UtilityNetwork::doneLoading, this, &TraceUtilityNetwork::addUtilityNetworkToMap);

  m_utilityNetwork->load();

  setBusyIndicator(true);
}

bool TraceUtilityNetwork::hasErrorOccurred(const Error& error)
{
  if (error.isEmpty())
    return false;

  m_dialogText = QString(error.message() + " - " + error.additionalMessage());
  emit dialogVisibleChanged();
  return true;
}

void TraceUtilityNetwork::onTaskFailed_(const Esri::ArcGISRuntime::ErrorException& exception)
{
  m_dialogText = QString(exception.error().message() + " - " + exception.error().additionalMessage());
  emit dialogVisibleChanged();
}

void TraceUtilityNetwork::addUtilityNetworkToMap(const Error& error)
{
  setBusyIndicator(false);

  if (hasErrorOccurred(error))
    return;

  m_map->utilityNetworks()->append(m_utilityNetwork);

  connectSignals();
}

void TraceUtilityNetwork::connectSignals()
{
  // identify layers on mouse click
  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.position().x(), mouseEvent.position().y());
    m_taskCanceler->addTask(m_mapView->identifyLayersAsync(mouseEvent.position(), tolerance, returnPopups).then(this, [this](const QList<IdentifyLayerResult*>& results)
    {
      onIdentifyLayersCompleted_(results);
    }));
  });
}

TraceUtilityNetwork::~TraceUtilityNetwork() = default;

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

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

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

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

  emit mapViewChanged();
}

void TraceUtilityNetwork::multiTerminalIndex(int index)
{
  if (m_terminals.isEmpty())
    return;

  if (!m_feature)
    return;

  UtilityElement* element = m_utilityNetwork->createElementWithArcGISFeature(m_feature, m_terminals[index]);
  updateTraceParams(element);
}

void TraceUtilityNetwork::updateTraceParams(UtilityElement* element)
{
  if (m_startingLocationsEnabled)
  {
    m_startingLocations.append(element);
    Graphic* traceLocation = new Graphic(m_clickPoint, m_startingSymbol, m_graphicParent.get());
    m_graphicsOverlay->graphics()->append(traceLocation);
  }
  else
  {
    m_barriers.append(element);
    Graphic* traceLocation = new Graphic(m_clickPoint, m_barrierSymbol, m_graphicParent.get());
    m_graphicsOverlay->graphics()->append(traceLocation);
  }
}

void TraceUtilityNetwork::trace(int index)
{
  setBusyIndicator(true);

  delete m_traceParams;

  switch (index)
  {
    case 0:
      m_traceParams = new UtilityTraceParameters(UtilityTraceType::Connected, {}, this);
      break;
    case 1:
      m_traceParams = new UtilityTraceParameters(UtilityTraceType::Subnetwork, {}, this);
      break;
    case 2:
      m_traceParams = new UtilityTraceParameters(UtilityTraceType::Upstream, {}, this);
      break;
    case 3:
      m_traceParams = new UtilityTraceParameters(UtilityTraceType::Downstream, {}, this);
      break;
    default:
      return;
  }

  if (m_mediumVoltageTier)
    m_traceParams->setTraceConfiguration(m_mediumVoltageTier->defaultTraceConfiguration());

  m_traceParams->setStartingLocations(m_startingLocations);
  m_traceParams->setBarriers(m_barriers);
  // Perform a connected trace on the utility network
  m_taskCanceler->addTask(m_utilityNetwork->traceAsync(m_traceParams).then(this, [this](QList<UtilityTraceResult*>)
  {
    onTraceCompleted_();
  }).onFailed([this](const ErrorException& exception)
  {
    onTaskFailed_(exception);
  }));
}

void TraceUtilityNetwork::reset()
{
  m_startingLocations.clear();
  m_barriers.clear();
  if (m_traceParams)
  {
    m_traceParams->setStartingLocations(m_startingLocations);
    m_traceParams->setBarriers(m_barriers);
  }

  m_graphicsOverlay->graphics()->clear();
  m_graphicParent.reset(new QObject());

  for (Layer* layer : *m_map->operationalLayers())
  {
    FeatureLayer* featureLayer = dynamic_cast<FeatureLayer*>(layer);
    if (!featureLayer)
      return;

    featureLayer->clearSelection();
  }
}

void TraceUtilityNetwork::onIdentifyLayersCompleted_(const QList<IdentifyLayerResult*>& results)
{
  if (results.isEmpty())
  {
    m_dialogText = QString("Could not identify location.");
    emit dialogTextChanged();
    m_dialogVisible = true;
    emit dialogVisibleChanged();
    return;
  }

  // Get domain network
  const UtilityDomainNetwork* domainNetwork = m_utilityNetwork->definition()->domainNetwork("ElectricDistribution");
  m_mediumVoltageTier = domainNetwork->tier("Medium Voltage Radial");

  const IdentifyLayerResult* result = results[0];
  m_feature = static_cast<ArcGISFeature*>(std::as_const(result)->geoElements()[0]);
  UtilityElement* element = nullptr;
  const UtilityNetworkSource* networkSource = m_utilityNetwork->definition()->networkSource(m_feature->featureTable()->tableName());

  if (networkSource->sourceType() == UtilityNetworkSourceType::Junction)
  {
    m_junctionSelected = true;
    emit junctionSelectedChanged();

    const QString assetGroupFieldName = static_cast<ArcGISFeatureTable*>(m_feature->featureTable())->subtypeField();
    const int assetGroupCode = m_feature->attributes()->attributeValue(assetGroupFieldName).toInt();
    UtilityAssetGroup* assetGroup = nullptr;

    const auto groups = networkSource->assetGroups();
    for (UtilityAssetGroup* group : groups)
    {
      if (group->code() == assetGroupCode)
      {
        assetGroup = group;
        break;
      }
    }
    if (!assetGroup)
      return;

    const int assetTypeCode = m_feature->attributes()->attributeValue("assettype").toInt();

    UtilityAssetType* assetType = nullptr;
    const auto types = assetGroup->assetTypes();
    for (UtilityAssetType* type : types)
    {
      if (type->code() == assetTypeCode)
      {
        assetType = type;
        break;
      }
    }

    if (!assetType)
      return;

    m_terminals = assetType->terminalConfiguration()->terminals();

    if (m_terminals.size() > 1)
    {
      m_terminalDialogVisisble = true;
      emit terminalDialogVisisbleChanged();
      return;
    }
    else if (m_terminals.size() == 1)
      element = m_utilityNetwork->createElementWithArcGISFeature(m_feature, m_terminals[0]);
    else
      return;

  }
  else if (networkSource->sourceType() == UtilityNetworkSourceType::Edge)
  {
    m_junctionSelected = false;
    emit junctionSelectedChanged();

    element = m_utilityNetwork->createElementWithArcGISFeature(m_feature, nullptr, this);

    // Compute how far tapped location is along the edge feature.
    if (m_feature->geometry().geometryType() == GeometryType::Polyline)
    {
      const Polyline line = geometry_cast<Polyline>(GeometryEngine::removeZ(m_feature->geometry()));
      // Set how far the element is along the edge.
      element->setFractionAlongEdge(GeometryEngine::fractionAlong(line, m_clickPoint, -1));
      m_fractionAlongEdge = element->fractionAlongEdge();
      emit fractionAlongEdgeChanged();
    }
  }
  else
  {
    return;
  }

  updateTraceParams(element);
}

void TraceUtilityNetwork::onTraceCompleted_()
{
  m_dialogVisible = true;
  emit dialogVisibleChanged();

  if (m_utilityNetwork->traceResult()->isEmpty())
  {
    setBusyIndicator(false);
    return;
  }

  m_dialogText = QString("Trace completed.");
  emit dialogTextChanged();

  UtilityTraceResult* result = m_utilityNetwork->traceResult()->at(0);

  const QList<UtilityElement*> elements = static_cast<UtilityElementTraceResult*>(result)->elements(this);

  QueryParameters deviceParams;
  QueryParameters lineParams;
  QList<qint64> deviceObjIds;
  QList<qint64> lineObjIds;

  for (UtilityElement* item : elements)
  {
    if (item->networkSource()->name() == "Electric Distribution Device")
      deviceObjIds.append(item->objectId());
    else if (item->networkSource()->name() == "Electric Distribution Line")
      lineObjIds.append(item->objectId());
  }

  deviceParams.setObjectIds(deviceObjIds);
  lineParams.setObjectIds(lineObjIds);

  m_taskCanceler->addTask(m_deviceLayer->selectFeaturesAsync(deviceParams, SelectionMode::Add).then(this, [this](FeatureQueryResult*)
  {
    setBusyIndicator(false);
  }));

  m_taskCanceler->addTask(m_lineLayer->selectFeaturesAsync(lineParams, SelectionMode::Add).then(this, [this](FeatureQueryResult*)
  {
    setBusyIndicator(false);
  }));
}

UniqueValue* TraceUtilityNetwork::createUniqueValue(const QString& label, Esri::ArcGISRuntime::Symbol* fillSymbol, int value)
{
  // add state's attribute value for field "STATE_ABBR" to QVariantList
  QVariantList labelValue;
  labelValue.append(value);

  // set value for a State to be rendered. (label, description, attribute value list, symbol, parent)
  UniqueValue* uniqueValue = new UniqueValue(label, "", labelValue, fillSymbol, this);

  // return Unique value created
  return uniqueValue;
}

void TraceUtilityNetwork::setBusyIndicator(bool status)
{
  m_busy = status;
  emit busyChanged();

  return;
}