Class UtilityNetwork
An instance of this class represents the central Utility Network.
Inheritance
Namespace: Esri.ArcGISRuntime.UtilityNetworks
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class UtilityNetwork : INotifyPropertyChanged, ILoadableRemarks
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. |
| DirtyAreaTable | Gets the dirty area table of the UtilityNetwork. |
| Geodatabase | Gets the Geodatabase that contains this UtilityNetwork. |
| LoadError | Gets the exception associated with a failed load. This property remains |
| 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 |
|---|---|
| AddAssociationAsync(UtilityAssociation) | Adds an association between two utility elements in this utility network. |
| CanAddAssociationAsync(UtilityAssociation) | Checks if the utility association can be added to the utility network. |
| CanAddAssociationAsync(UtilityAssociationType, UtilityElement, UtilityElement) | Checks if a utility association with the specified type between the specified utility elements can be added to the utility network. |
| CancelLoad() | Cancel the previous load operation. |
| CanDeleteAssociations() | Checks whether associations can be deleted. |
| 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. |
| DeleteAssociationAsync(UtilityAssociation) | Deletes an association from this utility network. |
| DeleteAssociationsAsync(IEnumerable<UtilityAssociation>) | Deletes a collection of associations from this utility network. |
| GetAssociationsAsync(Envelope) | Asynchronously retrieves a list of all UtilityAssociation objects (with their geometry) present
in the geodatabase for a given |
| GetAssociationsAsync(Envelope, UtilityAssociationType) | Asynchronously retrieves a list of all UtilityAssociation objects (with their geometry)
of type |
| GetAssociationsAsync(Envelope, UtilityAssociationType, CancellationToken) | Asynchronously retrieves a list of all UtilityAssociation objects (with their geometry)
of type |
| GetAssociationsAsync(Envelope, CancellationToken) | Asynchronously retrieves a list of all UtilityAssociation objects (with their geometry) present
in the geodatabase for a given |
| 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. |
| GetStateAsync() | Asynchronously retrieves the current state of the utility network. |
| GetStateAsync(CancellationToken) | Asynchronously retrieves the current state of the utility network. |
| LoadAsync() | Asynchronously initiates loading of this utility network. |
| QueryNamedTraceConfigurationsAsync(UtilityNamedTraceConfigurationQueryParameters) | Asynchronously retrieves a list of all UtilityNamedTraceConfiguration objects
matching the optional |
| QueryNamedTraceConfigurationsAsync(UtilityNamedTraceConfigurationQueryParameters, CancellationToken) | Asynchronously retrieves a list of all UtilityNamedTraceConfiguration objects
matching the optional |
| 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. |
| ValidateNetworkTopology(Envelope) | Returns a job that when started will validate the utility network topology within the provided extent. |
| ValidateNetworkTopology(Envelope, GeoprocessingExecutionType) | Returns a job that when started will validate the utility network topology within the provided extent. |
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
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.6 - 200.5 |
| .NET | 100.13 - 200.5 |
| .NET Windows | 100.13 - 200.5 |
| .NET Android | 200.0 - 200.5 |
| .NET iOS | 200.0 - 200.5 |
| .NET Framework | 100.6 - 200.5 |
| Xamarin.Android | 100.6 - 100.15 |
| Xamarin.iOS | 100.6 - 100.15 |
| UWP | 100.6 - 200.5 |