Show / Hide Table of Contents

Class UtilityNetwork

An instance of this class represents the central Utility Network.

Inheritance
Object
UtilityNetwork
Implements
INotifyPropertyChanged
ILoadable
Object.ToString()
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: Esri.ArcGISRuntime.UtilityNetworks
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class UtilityNetwork : INotifyPropertyChanged, ILoadable
Remarks

This is the central class for utility network schema information and tracing. UtilityNetwork follows the ILoadable pattern. When it loads, it is populated with the utility network schema. This class provides methods to create UtilityElement objects for the UtilityNetwork.

Constructors

Name Description
UtilityNetwork(Uri)

Initializes a new instance of the UtilityNetwork class using the URI to the feature service.

UtilityNetwork(Uri, Map)

Initializes a new instance of the UtilityNetwork class using the URL to the feature service and a map.

Properties

Name Description
Definition

Gets the definition of the utility network.

Geodatabase

Gets the Geodatabase that contains this UtilityNetwork.

LoadError

Gets the exception associated with a failed load. This property remains null if load is successful.

LoadStatus

Gets the current load status.

Name

Gets the name of the utility network.

ServiceGeodatabase

Gets the ServiceGeodatabase of the UtilityNetwork.

Uri

Gets the feature service URI used to create utility network.

Methods

Name Description
CancelLoad()

Cancel the previous load operation.

CreateAsync(Uri)

Creates and loads utility network using the URI to the feature service.

CreateAsync(Uri, Map)

Creates and loads utility network using the URL to the feature service and a map.

CreateElement(ArcGISFeature)

Creates a UtilityElement from a feature.

CreateElement(ArcGISFeature, UtilityTerminal)

Creates a UtilityElement from a feature.

CreateElement(UtilityAssetType, Guid)

Creates a UtilityElement from a UtilityAssetType and a global ID.

CreateElement(UtilityAssetType, Guid, UtilityTerminal)

Creates a UtilityElement from a UtilityAssetType, a global ID, and an optional UtilityTerminal.

GetAssociationsAsync(Envelope)

Asynchronously retrieves a list of all UtilityAssociation objects (with their geometry) present in the geodatabase for a given extent.

GetAssociationsAsync(Envelope, UtilityAssociationType)

Asynchronously retrieves a list of all UtilityAssociation objects (with their geometry) of type type present in the geodatabase for a given extent.

GetAssociationsAsync(Envelope, UtilityAssociationType, CancellationToken)

Asynchronously retrieves a list of all UtilityAssociation objects (with their geometry) of type type present in the geodatabase for a given extent.

GetAssociationsAsync(Envelope, CancellationToken)

Asynchronously retrieves a list of all UtilityAssociation objects (with their geometry) present in the geodatabase for a given extent.

GetAssociationsAsync(UtilityElement)

Asynchronously retrieves a list of all UtilityAssociations in the geodatabase for a given UtilityElement.

GetAssociationsAsync(UtilityElement, UtilityAssociationType)

Asynchronously retrieves a list of all UtilityAssociations of type UtilityAssociationType present in the geodatabase for a given UtilityElement.

GetAssociationsAsync(UtilityElement, UtilityAssociationType, CancellationToken)

Asynchronously retrieves a list of all UtilityAssociations of type UtilityAssociationType present in the geodatabase for a given UtilityElement.

GetAssociationsAsync(UtilityElement, CancellationToken)

Asynchronously retrieves a list of all UtilityAssociations in the geodatabase for a given UtilityElement.

GetFeaturesForElementsAsync(IEnumerable<UtilityElement>)

Asynchronously gets the set of loaded ArcGISFeatures referenced by a set of UtilityElements.

GetFeaturesForElementsAsync(IEnumerable<UtilityElement>, CancellationToken)

Asynchronously gets the set of loaded ArcGISFeatures referenced by a set of UtilityElements.

LoadAsync()

Asynchronously initiates loading of this utility network.

QueryNamedTraceConfigurationsAsync(UtilityNamedTraceConfigurationQueryParameters)

Asynchronously retrieves a list of all UtilityNamedTraceConfiguration objects matching the optional queryParameters from the utility network.

QueryNamedTraceConfigurationsAsync(UtilityNamedTraceConfigurationQueryParameters, CancellationToken)

Asynchronously retrieves a list of all UtilityNamedTraceConfiguration objects matching the optional queryParameters from the utility network.

RetryLoadAsync()

Asynchronously retries loading of this utility network.

TraceAsync(UtilityTraceParameters)

Asynchronously begins a trace with the supplied UtilityTraceParameters.

TraceAsync(UtilityTraceParameters, CancellationToken)

Asynchronously begins a trace with the supplied UtilityTraceParameters.

Events

Name Description
Loaded

Occurs when the utility network is loaded.

LoadStatusChanged

Occurs when the utility network LoadStatus is changed.

PropertyChanged

Occurs when a property value changes.

Applies to

TargetVersions
.NET Standard 2.0100.6 - 200.0
.NET 6.0100.13 - 200.0
.NET 6.0 Windows100.13 - 200.0
.NET 6.0 Android200
.NET 6.0 iOS200
.NET Framework100.6 - 200.0
.NET 5100.10 - 100.12
.NET Core 3.1100.7 - 100.12
Android100.6 - 100.15
iOS100.6 - 100.15
UWP100.6 - 200.0

Relevant samples

Configure subnetwork trace: Get a server-defined trace configuration for a given tier and modify its traversability scope, add new condition barriers and control what is included in the subnetwork trace result.
Perform valve isolation trace: Run a filtered trace to locate operable features that will isolate an area from the flow of network resources.
Trace utility network: Discover connected features in a utility network using connected, subnetwork, upstream, and downstream traces.
In This Article
Back to top Copyright © 2022 Esri.