UtilityDomainNetwork

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.

UtilityDomainNetwork objects can be obtained from the utility network definition using the UtilityNetworkDefinition.domainNetworks property.

Since

200.1.0

Properties

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

Whether this UtilityDomainNetwork is the structure network.

Link copied to clipboard

The normalized name of the UtilityDomainNetwork.

Link copied to clipboard
Link copied to clipboard

The type of subnetwork controller supported in this UtilityDomainNetwork.

Link copied to clipboard

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

Link copied to clipboard

A collection of all of the UtilityTier objects for this domain network.

Link copied to clipboard

The tier type of this domain network. Valid values in the UtilityTierType enum are Hierarchical (typically used with pressure networks) and Partitioned (typically used with electrical networks).

Functions

Link copied to clipboard
fun getTier(tierName: String): UtilityTier?

Gets the UtilityTier object with the specified name.

Link copied to clipboard
fun getTierGroup(tierGroupName: String): UtilityTierGroup?

Gets the UtilityTierGroup object with the specified name.