ArcGIS Developers

UtilityDomainNetwork Class

class Esri::ArcGISRuntime::UtilityDomainNetwork

A domain network inside a utility network. More...

Header: #include <UtilityDomainNetwork>
Since: Esri::ArcGISRuntime 100.7
Inherits: Esri::ArcGISRuntime::Object

This class was introduced in Esri::ArcGISRuntime 100.7.

Public Functions

virtual ~UtilityDomainNetwork() override
QString alias() const
int domainNetworkId() const
bool isStructureNetwork() const
QString name() const
QList<Esri::ArcGISRuntime::UtilityNetworkSource *> networkSources() const
Esri::ArcGISRuntime::UtilitySubnetworkControllerType subnetworkControllerType() const
Esri::ArcGISRuntime::UtilityTier *tier(const QString &tierName) const
Esri::ArcGISRuntime::UtilityTierGroup *tierGroup(const QString &tierGroupName) const
QList<Esri::ArcGISRuntime::UtilityTierGroup *> tierGroups() const
Esri::ArcGISRuntime::UtilityTierType tierType() const
QList<Esri::ArcGISRuntime::UtilityTier *> tiers() const

Detailed Description

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.

Member Function Documentation

[override virtual] UtilityDomainNetwork::~UtilityDomainNetwork()


QString UtilityDomainNetwork::alias() const

Returns the display (non-normalized) name of the UtilityDomainNetwork.

This name is suitable for display to end-users.

int UtilityDomainNetwork::domainNetworkId() const

Returns the ID of the UtilityDomainNetwork.

bool UtilityDomainNetwork::isStructureNetwork() const

Returns whether this UtilityDomainNetwork is the structure network.

QString UtilityDomainNetwork::name() const

Returns the normalized name of the UtilityDomainNetwork.

QList<Esri::ArcGISRuntime::UtilityNetworkSource *> UtilityDomainNetwork::networkSources() const

Returns the collection of UtilityNetworkSource objects in this UtilityDomainNetwork.

Esri::ArcGISRuntime::UtilitySubnetworkControllerType UtilityDomainNetwork::subnetworkControllerType() const

Returns the type of subnetwork controller supported in this UtilityDomainNetwork.

Esri::ArcGISRuntime::UtilityTier *UtilityDomainNetwork::tier(const QString &tierName) const

Returns the UtilityTier object with the specified name.

  • tierName - The name of the desired UtilityTier object to return.

Esri::ArcGISRuntime::UtilityTierGroup *UtilityDomainNetwork::tierGroup(const QString &tierGroupName) const

Returns the UtilityTierGroup object with the specified name

QList<Esri::ArcGISRuntime::UtilityTierGroup *> UtilityDomainNetwork::tierGroups() const

Returns 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.

Esri::ArcGISRuntime::UtilityTierType UtilityDomainNetwork::tierType() const

Returns 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).

QList<Esri::ArcGISRuntime::UtilityTier *> UtilityDomainNetwork::tiers() const

Returns a collection of all of the UtilityTier objects for this domain network.

Feedback on this topic?