UtilityNetworkDefinition QML Type
The metadata of a utility network. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 100.6 |
| Inherits: |
Properties
- capabilities : UtilityNetworkCapabilities
- categories : list<UtilityCategory>
- domainNetworks : list<UtilityDomainNetwork>
- extent : Envelope
- networkAttributes : list<UtilityNetworkAttribute>
- networkSources : list<UtilityNetworkSource>
- schemaVersion : int
- terminalConfigurations : list<UtilityTerminalConfiguration>
Methods
- UtilityDomainNetwork domainNetwork(string name)
- UtilityNetworkAttribute networkAttribute(string name)
- UtilityNetworkSource networkSource(string name)
Detailed Description
Includes metadata such as domain networks, network sources, and so on.
Property Documentation
[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.
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.
[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.
[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.
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.
networkSources : list<UtilityNetworkSource> |
Returns a list of all the network sources in the UtilityNetworkDefinition (read-only).
schemaVersion : int |
Returns the utility network schema version number reported by the utility network meta data (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.
Method Documentation
|
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.