AGSUtilityNetworkDefinition Class Reference

Description

An object that represents the metadata of a utility network.

Provides metadata (e.g domain networks, network sources, and more) about a utility network service.

Since

100.6

Inheritance diagram for AGSUtilityNetworkDefinition:

Instance Methods
(nullable AGSUtilityDomainNetwork *)	- domainNetworkWithDomainNetworkName:
(nullable AGSUtilityNetworkAttribute *)	- networkAttributeWithName:
(nullable AGSUtilityNetworkSource *)	- networkSourceWithName:

Properties
NSArray< AGSUtilityCategory * > *	categories
NSArray< AGSUtilityDomainNetwork * > *	domainNetworks
AGSEnvelope *	extent
NSArray< AGSUtilityNetworkAttribute * > *	networkAttributes
NSArray< AGSUtilityNetworkSource * > *	networkSources
NSInteger	schemaVersion
NSArray< AGSUtilityTerminalConfiguration * > *	terminalConfigurations

Method Documentation

domainNetworkWithDomainNetworkName:

- (nullable AGSUtilityDomainNetwork *) domainNetworkWithDomainNetworkName:

(NSString *)

domainNetworkName

Gets the domain network with the specified name.

Parameters

domainNetworkName

The name of the domain network.

Returns

An AGSUtilityDomainNetwork object.

Since

100.7

networkAttributeWithName:

- (nullable AGSUtilityNetworkAttribute *) networkAttributeWithName:

(NSString *)

name

Gets the associated network attribute with the specified network attribute name.

Parameters

name	The name of the network attribute.

Returns

An AGSUtilityNetworkAttribute object.

Since

100.6

networkSourceWithName:

- (nullable AGSUtilityNetworkSource *) networkSourceWithName:

(NSString *)

name

Gets the associated network source with the specified network source name.

Parameters

name	The name of the network source.

Returns

An AGSUtilityNetworkSource object.

Since

100.6

Property Documentation

categories

- (NSArray<AGSUtilityCategory *>*) categories

readnonatomiccopy

The array of utility network categories in the utility network metadata. An AGSUtilityCategory object is used to define a characteristic of an asset in a network. The objects in this array incorporate semantics of the utility network for subnetwork management and tracing operations.

Since

100.6

domainNetworks

- (NSArray<AGSUtilityDomainNetwork *>*) domainNetworks

readnonatomiccopy

The array of domain networks in the utility network metadata. 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.

Since

100.7

extent

- (AGSEnvelope*) extent

readnonatomicstrong

The AGSEnvelope object representing the service territory area used to define the AGSUtilityNetwork object. This is the extent of the network topology (i.e., the extent of the service territory plus a small buffer).

Since

100.8

networkAttributes

- (NSArray<AGSUtilityNetworkAttribute *>*) networkAttributes

readnonatomiccopy

The network attributes in the utility network definition. An AGSUtilityNetworkAttribute object 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.

Since

100.6

networkSources

- (NSArray<AGSUtilityNetworkSource *>*) networkSources

readnonatomiccopy

The array of network sources in the utility network definition. AGSUtilityNetworkSource objects represent various sources of network information such as structures, lines, junctions, and associations.

Since

100.6

schemaVersion

- (NSInteger) schemaVersion

readnonatomicassign

The utility network schema version number reported by the utility network metadata. Only certain schema versions are supported by ArcGIS Runtime.

Since

100.6

terminalConfigurations

- (NSArray<AGSUtilityTerminalConfiguration *>*) terminalConfigurations

readnonatomiccopy

The AGSUtilityTerminalConfiguration objects defined for this utility network.

Since

100.7