AGSUtilityDomainNetwork Class Reference

Description

A domain network inside a utility network.

Domain networks organize features in a utility network based on what utility service they provide, such as natural gas, water, electricity, or structural elements such as poles or conduits. Each utility network will have a single structure network and one or more domain networks for the actual utility services they provide.

AGSUtilityDomainNetwork objects can be obtained from the utility network definition. using the AGSUtilityNetworkDefinition::domainNetworks property.

Since

100.7

Inheritance diagram for AGSUtilityDomainNetwork:

Instance Methods
(nullable AGSUtilityTierGroup *)	- tierGroupWithName:
(nullable AGSUtilityTier *)	- tierWithName:

Properties
NSString *	alias
NSInteger	domainNetworkID
NSString *	name
NSArray< AGSUtilityNetworkSource * > *	networkSources
BOOL	structureNetwork
AGSUtilitySubnetworkControllerType	subnetworkControllerType
NSArray< AGSUtilityTierGroup * > *	tierGroups
NSArray< AGSUtilityTier * > *	tiers
AGSUtilityTierType	tierType

Method Documentation

tierGroupWithName:

- (nullable AGSUtilityTierGroup *) tierGroupWithName:

(NSString *)

name

Gets the AGSUtilityTierGroup object with the specified name.

Parameters

name	The name of the desired AGSUtilityTierGroup object to return.

Returns

An AGSUtilityTierGroup object with the specified name.

Since

100.7

tierWithName:

- (nullable AGSUtilityTier *) tierWithName:

(NSString *)

name

Gets the AGSUtilityTier object with the specified name.

Parameters

name	The name of the desired AGSUtilityTier object to return.

Returns

An AGSUtilityTier object with the specified name.

Since

100.7

Property Documentation

alias

- (NSString*) alias

readnonatomiccopy

The display (non-normalized) name of the AGSUtilityDomainNetwork object. This name is suitable for display to end-users.

Since

100.7

domainNetworkID

- (NSInteger) domainNetworkID

readnonatomicassign

The ID of the AGSUtilityDomainNetwork object.

Since

100.7

name

- (NSString*) name

readnonatomiccopy

The normalized name of the AGSUtilityDomainNetwork object.

Since

100.7

networkSources

- (NSArray<AGSUtilityNetworkSource *>*) networkSources

readnonatomiccopy

The array of AGSUtilityNetworkSource objects in this AGSUtilityDomainNetwork object.

Since

100.7

structureNetwork

- (BOOL) structureNetwork

readnonatomicassign

Whether this AGSUtilityDomainNetwork object is the structure network.

Since

100.7

subnetworkControllerType

- (AGSUtilitySubnetworkControllerType) subnetworkControllerType

readnonatomicassign

The type of subnetwork controller supported in this AGSUtilityDomainNetwork object.

Since

100.7

tierGroups

- (NSArray<AGSUtilityTierGroup *>*) tierGroups

readnonatomiccopy

An array of all of the AGSUtilityTierGroup objects for this domain network. Only hierarchical domain networks support tier groups. If no tier groups exist, an empty list is returned.

Since

100.7

tiers

- (NSArray<AGSUtilityTier *>*) tiers

readnonatomiccopy

An array of all of the AGSUtilityTier objects for this domain network.

Since

100.7

tierType

- (AGSUtilityTierType) tierType

readnonatomicassign

The tier type of this domain network. Valid values in the AGSUtilityTierType enum are hierarchical (typically used with pressure networks) and partitioned (typically used with electrical networks).

Since

100.7