Perform valve isolation trace

View in

C++

QML

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

Create a MapView.
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 service geodatabases tables.
Create and load a UtilityNetwork with the feature service URL and the Map.
Add a GraphicsOverlay with a Graphic that represents the starting location, and another graphics overlay for the filter barriers.
Populate the list of filter barrier categories from UtilityNetworkDefinition.categories.
When the map view is clicked, identify which features are at that location and add a graphic that represents a filter barrier.
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, use the result from GeometryEngine.fractionAlong to set the elements fractionAlongEdge property.
If Trace is clicked with filter barriers:
- Update the default configurations include isolated features property.
- Update the UtilityTraceParameters filter barriers property.
- Run UtilityNetwork.trace.
If 'Trace' is clicked without filter barriers:

Create a new UtilityCategoryComparison with the selected category and Enums.UtilityCategoryComparisonOperatorExists.
Assign this condition to UtilityTraceFilter.barriers from the default configuration from step 6. Update this configuration's includeIsolatedFeatures property.
Run UtilityNetwork.trace.

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

ServiceGeodatabase
UtilityCategory
UtilityCategoryComparison
UtilityCategoryComparisonOperator
UtilityDomainNetwork
UtilityElement
UtilityElementTraceResult
UtilityNetwork
UtilityNetworkDefinition
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

Sample Code

PerformValveIsolationTrace.qml

TerminalPickerView.qml

Use dark colors for code blocksCopy
// [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]

import QtQuick 2.6
import QtQuick.Controls 2.2
import Esri.ArcGISRuntime 100.15
import QtQuick.Layouts 1.11
import QtQuick.Dialogs 1.1

Rectangle {
    id: rootRectangle
    clip: true
    width: 800
    height: 600

    readonly property url featureServiceUrl: "https://sampleserver7.arcgisonline.com/server/rest/services/UtilityNetwork/NapervilleGas/FeatureServer"
    readonly property string domainNetworkName: "Pipeline"
    readonly property string tierName: "Pipe Distribution System"
    readonly property string networkSourceName: "Gas Device"
    readonly property string assetGroupName: "Meter"
    readonly property string assetTypeName: "Customer"
    readonly property string globalId: "98A06E95-70BE-43E7-91B7-E34C9D3CB9FF"
    readonly property string sampleServer7Username: "viewer01"
    readonly property string sampleServer7Password: "I68VGU^nMurF"
    property var clickPoint: null
    property var filterBarriers: []
    property var createdElement: null
    property var traceConfiguration: null
    property var startingLocation: null
    property var categories: null
    property bool uiEnabled: false
    property var distributionLineLayerFeatureTable: null
    property var deviceLayerFeatureTable: null

    ListModel {
        id: terminalNamesModel
    }

    MapView {
        id: mapView
        anchors.fill: parent

        Component.onCompleted: {
            // Set the focus on MapView to initially enable keyboard navigation
            forceActiveFocus();
        }

        onMouseClicked: {
            const screenX = mouse.x;
            const screenY = mouse.y;
            const tolerance = 10;
            const returnPopups = false;
            clickPoint = mouse.mapPoint;
            mapView.identifyLayers(screenX, screenY, tolerance, returnPopups);
        }

        onIdentifyLayersStatusChanged : {
            if (identifyLayersStatus !== Enums.TaskStatusCompleted)
                return;

            const results = mapView.identifyLayersResults;
            const identifiedLayerResult = results[0];

            // could not identify location
            if (!identifiedLayerResult)
                return;

            const feature = identifiedLayerResult.geoElements[0];

            let element = utilityNetwork.createElementWithArcGISFeature(feature);

            createdElement = element;

            const elementSourceType = element.networkSource.sourceType;

            if (elementSourceType === Enums.UtilityNetworkSourceTypeJunction) {
                const terminals = element.assetType.terminalConfiguration.terminals;
                if (terminals.length > 1) {
                    terminalNamesModel.clear();

                    for (let i = 0; i < terminals.length; i++) {
                        terminalNamesModel.append({text: terminals[i].name});
                    }

                    terminalPickerView.visible = true;
                    return;
                }
            } else if (elementSourceType === Enums.UtilityNetworkSourceTypeEdge) {

                if (feature.geometry.geometryType === Enums.GeometryTypePolyline) {
                    const line = GeometryEngine.removeZ(feature.geometry);
                    // Set how far the element is along the edge.
                    const fraction = GeometryEngine.fractionAlong(line, clickPoint, -1);
                    element.fractionAlongEdge = fraction;
                }
            }
            let graphic = ArcGISRuntimeEnvironment.createObject("Graphic", {geometry: clickPoint});

            filterBarriersOverlay.graphics.append(graphic);
            filterBarriers.push(element);
        }

        GraphicsOverlay {
            id: startingLocationOverlay
            Graphic {
                id: startingLocationGraphic
                SimpleMarkerSymbol {
                    style: Enums.SimpleMarkerSymbolStyleCross
                    color: "lime"
                    size: 25
                }
            }
        }

        GraphicsOverlay {
            id: filterBarriersOverlay
            SimpleRenderer {
                SimpleMarkerSymbol {
                    style: Enums.SimpleMarkerSymbolStyleX
                    color: "red"
                    size: 25
                }
            }
        }

        Credential {
            id: cred
            username: sampleServer7Username
            password: sampleServer7Password
        }

        Map {
            id: map

            Basemap {
                initStyle: Enums.BasemapStyleArcGISStreetsNight
            }

            Component.onCompleted: {
                serviceGeodatabase.load();
                utilityNetwork.load();
                map.utilityNetworks.append(utilityNetwork);
            }

            ServiceGeodatabase {
                id: serviceGeodatabase
                url: featureServiceUrl
                credential: cred
                onLoadStatusChanged: {
                    if (loadStatus === Enums.LoadStatusLoaded) {

                        // obtain service feature tables from service geodatabase and store them in global properties
                        distributionLineLayerFeatureTable = serviceGeodatabase.tableWithLayerIdAsInt(3);
                        deviceLayerFeatureTable = serviceGeodatabase.tableWithLayerIdAsInt(0);

                        // set each service feature table to their respective feature layer
                        distributionLineLayer.featureTable = distributionLineLayerFeatureTable;
                        deviceLayer.featureTable = deviceLayerFeatureTable;
                    }
                }
            }

            FeatureLayer {
                id: distributionLineLayer
            }

            FeatureLayer {
                id: deviceLayer
            }

            UtilityCategoryComparison {
                id: categoryComparison
            }

            UtilityTraceFilter {
                id: traceFilter
            }

            UtilityTraceParameters {
                id: traceParameters
            }

            QueryParameters {
                id: queryParameters
            }

            UtilityNetwork {
                id: utilityNetwork
                url: featureServiceUrl
                credential: cred

                onTraceStatusChanged: {

                    if (traceStatus !== Enums.TaskStatusCompleted)
                        return;

                    // re-enable UI and select features
                    uiEnabled = true;

                    if (traceResult.count < 1) {
                        messageDialog.visible = true;
                        return;
                    }

                    let utilityTraceResult = traceResult.get(0);
                    let allElements = traceResult.get(0).elements;

                    // if no elements found, then display message
                    if (allElements.length === 0) {
                        messageDialog.visible = true;
                        return;
                    }

                    // iterate through the map's features
                    for (let i = 0; i < map.operationalLayers.count; i++) {
                        let currentFeatureLayer = map.operationalLayers.get(i);

                        // create query parameters to find features whose network names match the layer's feature table name
                        let objectIds = [];
                        for (let j = 0; j < allElements.length; j++) {
                            let networkSourceName = allElements[j].networkSource.name;
                            let featureTableName = currentFeatureLayer.featureTable.tableName;

                            if (networkSourceName === featureTableName) {
                                objectIds.push(allElements[j].objectId);
                            }
                        }

                        queryParameters.objectIdsAsInts = objectIds;
                        currentFeatureLayer.selectFeaturesWithQuery(queryParameters, Enums.SelectionModeNew);
                    }
                }

                onFeaturesForElementsStatusChanged: {
                    if (featuresForElementsStatus !== Enums.TaskStatusCompleted)
                        return;

                    // display starting location
                    if (featuresForElementsResult.count > 0) {
                        let startingLocationGeometry = featuresForElementsResult.get(0).geometry;
                        startingLocationGraphic.geometry = startingLocationGeometry;
                        mapView.setViewpointCenterAndScale(startingLocationGeometry, 3000);

                        uiEnabled = true;
                    }
                }

                onLoadStatusChanged: {
                    if (loadStatus !== Enums.LoadStatusLoaded)
                        return;

                    // get a trace configuration from a tier
                    if (definition.domainNetwork(domainNetworkName) !== null) {
                        let domainNetwork = definition.domainNetwork(domainNetworkName);
                        if (domainNetwork.tier(tierName) !== null) {
                            let tier = domainNetwork.tier(tierName);
                            traceConfiguration = tier.defaultTraceConfiguration();
                        }
                    }

                    if (traceConfiguration === null)
                        return;

                    // set the trace filter
                    traceConfiguration.filter = traceFilter;

                    // get a default starting location
                    if (definition.networkSource(networkSourceName) !== null) {
                        let networkSource = definition.networkSource(networkSourceName);
                        if (networkSource.assetGroup(assetGroupName) !== null) {
                            let assetGroup = networkSource.assetGroup(assetGroupName);
                            if (assetGroup.assetType(assetTypeName) !== null) {
                                let assetType = assetGroup.assetType(assetTypeName);
                                startingLocation = createElementWithAssetType(assetType, globalId);
                            }
                        }
                    }

                    if (startingLocation === null)
                        return;

                    // display starting location
                    featuresForElements([startingLocation]);

                    // populate the combo box choices
                    let allCategories = definition.categories;
                    categories = [];
                    for (let i = 0; i < allCategories.length; i++) {
                        categories.push(allCategories[i].name);
                    }
                    comboBox.model = categories;
                }
            }
        }

        ColumnLayout {
            anchors {
                left: parent.left
                top: parent.top
            }
            Rectangle {
                id: backgroundRect
                color: "#FBFBFB"
                height: childrenRect.height
                width: row.width * 1.25

                RowLayout {
                    id: titleRow
                    Rectangle {
                        color: backgroundRect.color
                        width: childrenRect.width
                        height: childrenRect.height
                        Text {
                            text: "Choose category for filter barrier:"
                            font.pixelSize: 14
                        }
                    }
                    anchors {
                        left: row.left
                        top: parent.top
                    }
                }

                RowLayout {
                    id: row
                    anchors {
                        horizontalCenter: parent.horizontalCenter
                        top: titleRow.bottom
                    }
                    ComboBox {
                        id: comboBox
                        enabled: uiEnabled
                        Layout.minimumWidth: 200
                        model: categories
                    }
                    Button {
                        text: "Trace"
                        onClicked: {
                            if (comboBox.currentIndex < 0)
                                return;

                            // disable UI and perform trace
                            uiEnabled = false;

                            // clear previous selection from the feature layers
                            for (let i = 0; i < map.operationalLayers.count; i++) {
                                map.operationalLayers.get(i).clearSelection();
                            }

                            let categoriesList = utilityNetwork.definition.categories;

                            // get the selected utility category
                            let selectedCategory = categoriesList[comboBox.currentIndex];
                            categoryComparison.category = selectedCategory;
                            categoryComparison.comparisonOperator = Enums.UtilityCategoryComparisonOperatorExists;

                            traceConfiguration.filter.barriers = null;

                            // set the category comparison to the barriers of the configuration's trace filter
                            if (filterBarriers.length > 0) {
                                traceParameters.filterBarriers = filterBarriers;
                            } else {
                                traceConfiguration.filter.barriers = categoryComparison;
                            }

                            // set whether to include isolated features
                            traceConfiguration.includeIsolatedFeatures = checkBox.checked;

                            // build parameters for the isolation trace
                            traceParameters.traceType = Enums.UtilityTraceTypeIsolation;
                            traceParameters.startingLocations = [startingLocation];
                            traceParameters.traceConfiguration = traceConfiguration;

                            utilityNetwork.trace(traceParameters);
                        }
                        enabled: uiEnabled
                    }
                    Button {
                        id: resetBtn
                        text: qsTr("Reset")
                        onClicked: {
                            filterBarriers = [];
                            traceParameters.filterBarriers = [];
                            filterBarriersOverlay.graphics.clear();
                            for (let i = 0; i < map.operationalLayers.count; i++) {
                                map.operationalLayers.get(i).clearSelection();
                            }
                        }
                        enabled: uiEnabled
                    }
                }

                RowLayout {
                    id: checkBoxRow
                    anchors {
                        top: row.bottom
                        left: row.left
                    }
                    CheckBox {
                        id: checkBox
                        text: "Include isolated features"
                        enabled: uiEnabled
                        leftPadding: 0
                    }
                }
            }
        }

        BusyIndicator {
            id: busyIndicator
            anchors.centerIn: parent
            running: utilityNetwork.traceStatus === Enums.TaskStatusInProgress
        }
    }

    TerminalPickerView {
        id: terminalPickerView
    }

    function selectTerminal(terminalIndex) {
        const terminal = createdElement.assetType.terminalConfiguration.terminals[terminalIndex];
        createdElement.terminal = terminal;

        let graphic = ArcGISRuntimeEnvironment.createObject("Graphic", {geometry: clickPoint});
        filterBarriersOverlay.graphics.append(graphic);

        filterBarriers.push(createdElement);
    }

    MessageDialog {
        id: messageDialog
        title: "Perform valve isolation trace"
        text: "Isolation trace returned no elements."
        visible: false
        onRejected: {
            visible = false;
        }
    }
}

Perform valve isolation trace

Your ArcGIS portal

Your ArcGIS Location Platform dashboard

Perform valve isolation trace

Use case

How to use the sample

How it works

Relevant API

About the data

Additional information

Tags

Sample Code

Your ArcGIS portal

Your ArcGIS Location Platform dashboard