UtilityNetworkDefinition QML Type
The metadata of a utility network. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 100.6 |
| Inherits: |
- List of all members, including inherited members
- UtilityNetworkDefinition is part of QML Type List.
Properties
- capabilities : UtilityNetworkCapabilities
- categories : list<UtilityCategory>
- domainNetworks : list<UtilityDomainNetwork>
- extent : Envelope
- networkAttributes : list<UtilityNetworkAttribute>
- networkSources : list<UtilityNetworkSource>
- rulesResult : list<UtilityRule>
- rulesResults : list<UtilityRule>
- rulesStatus : Enums.TaskStatus
- schemaVersion : int
- terminalConfigurations : list<UtilityTerminalConfiguration>
Signals
Methods
- bool cancelTask(string taskId)
- UtilityDomainNetwork domainNetwork(string name)
- UtilityNetworkAttribute networkAttribute(string name)
- UtilityNetworkSource networkSource(string name)
- string rules(list<UtilityAssetType> assetTypes)
Detailed Description
Includes metadata such as domain networks, network sources, and so on.
Property Documentation
[read-only, since Esri.ArcGISRuntime 200.0] capabilities : UtilityNetworkCapabilities |
Gets a value indicating the supported utility network capabilities (read-only). Use this property to determine which operations are available for this utility network.
This property was introduced in Esri.ArcGISRuntime 200.0.
[read-only] categories : list<UtilityCategory> |
Returns a list of utility network categories in the utility network meta data (read-only).
A UtilityCategory is used to define a characteristic of an asset in a network. The objects in this list incorporate semantics of the utility network for subnetwork management and tracing operations.
[read-only, since Esri.ArcGISRuntime 100.7] domainNetworks : list<UtilityDomainNetwork> |
The collection of domain networks in the utility network meta data (read-only).
Domain networks organize features in a utility network based on what utility service they provide, such as natural gas, water, electricity, or structural elements like poles or conduits.
This property was introduced in Esri.ArcGISRuntime 100.7.
[read-only, since Esri.ArcGISRuntime 100.8] extent : Envelope |
The Envelope representing the service territory area used to define the UtilityNetwork (read-only).
This is the extent of the network topology (i.e., the extent of the service territory plus a small buffer).
This property was introduced in Esri.ArcGISRuntime 100.8.
[read-only] networkAttributes : list<UtilityNetworkAttribute> |
Returns a list of utility network attributes in the utility network meta data (read-only).
A UtilityNetworkAttribute is an attribute that is copied and stored in the topological index. The utility network tracing task can read and make decisions using network attributes that are stored in the topological index.
[read-only] networkSources : list<UtilityNetworkSource> |
Returns a list of all the network sources in the UtilityNetworkDefinition (read-only).
[since Esri.ArcGISRuntime 200.1] rulesResult : list<UtilityRule> |
The result returned when the asynchronous rules operation completes (read-only).
This property was introduced in Esri.ArcGISRuntime 200.1.
[read-only, since Esri.ArcGISRuntime 200.1] rulesResults : list<UtilityRule> |
Returns the list of UtilityRule objects from a rules operation (read-only).
Access this property after calling rules and waiting for the rulesStatus to be complete.
This property was introduced in Esri.ArcGISRuntime 200.1.
[read-only, since Esri.ArcGISRuntime 200.1] rulesStatus : Enums.TaskStatus |
Returns the rulesStatus of the rules() method (read-only).
This property was introduced in Esri.ArcGISRuntime 200.1.
See also Enums.TaskStatus.
[read-only] schemaVersion : int |
Returns the utility network schema version number reported by the utility network meta data (read-only).
[read-only, since Esri.ArcGISRuntime 100.7] terminalConfigurations : list<UtilityTerminalConfiguration> |
Returns the UtilityTerminalConfiguration objects defined for this utility network (read-only).
This property was introduced in Esri.ArcGISRuntime 100.7.
Signal Documentation
|
Emitted when the rulesStatus property changes.
Note: The corresponding handler is onRulesStatusChanged.
This signal was introduced in Esri.ArcGISRuntime 200.1.
Method Documentation
bool cancelTask(string taskId) |
Cancel the task with the ID taskId.
Returns false if the task cannot be canceled or there is no task with the specified id taskId.
See also Cancelable.
|
Returns the domain network with the specified name.
This method was introduced in Esri.ArcGISRuntime 100.7.
UtilityNetworkAttribute networkAttribute(string name) |
Returns the network attribute with the specified network attribute name.
Returns null if there is no matching network attribute.
UtilityNetworkSource networkSource(string name) |
Returns the UtilityNetworkSource with the specified network source name.
Returns null if there is no matching network resource.
|
Queries for a subset of UtilityRule objects that apply to a set of UtilityAssetType.
- assetTypes - The collection of UtilityAssetType objects to query applicable UtilityRule objects.
Use this method to return network rules applicable to features of specific asset types. Limiting these asset types to those features being edited can substantially reduce the number of network rules returned.
These asset types will be matched against the UtilityRuleElement::assetType of the following rule elements:
If the collection of UtilityAssetType is empty or no matching rules are found for these asset types, an empty collection of UtilityRule objects is returned.
Returns a string representing the task ID of the asynchronous task.
This method was introduced in Esri.ArcGISRuntime 200.1.
See also UtilityAssetType.