Skip To Content ArcGIS for Developers Sign In Dashboard

UtilityNetworkDefinition Class

class Esri::ArcGISRuntime::UtilityNetworkDefinition

The metadata of a utility network feature service. More...

Header: #include <UtilityNetworkDefinition>
Since: Esri::ArcGISRuntime 100.6
Inherits: Esri::ArcGISRuntime::Object

This class was introduced in Esri::ArcGISRuntime 100.6.

Public Functions

virtual ~UtilityNetworkDefinition() override
QList<Esri::ArcGISRuntime::UtilityCategory *> categories() const
Esri::ArcGISRuntime::UtilityDomainNetwork *domainNetwork(const QString &name) const
QList<Esri::ArcGISRuntime::UtilityDomainNetwork *> domainNetworks() const
Esri::ArcGISRuntime::Envelope extent() const
Esri::ArcGISRuntime::UtilityNetworkAttribute *networkAttribute(const QString &name) const
QList<Esri::ArcGISRuntime::UtilityNetworkAttribute *> networkAttributes() const
Esri::ArcGISRuntime::UtilityNetworkSource *networkSource(const QString &name) const
QList<Esri::ArcGISRuntime::UtilityNetworkSource *> networkSources() const
int schemaVersion() const
QList<Esri::ArcGISRuntime::UtilityTerminalConfiguration *> terminalConfigurations() const

Detailed Description

Includes metadata such as domain networks, network sources, and so on.

Member Function Documentation

[override virtual] UtilityNetworkDefinition::~UtilityNetworkDefinition()

Destructor.

QList<Esri::ArcGISRuntime::UtilityCategory *> UtilityNetworkDefinition::categories() const

Returns a list of utility network categories in the utility network feature service.

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.

Esri::ArcGISRuntime::UtilityDomainNetwork *UtilityNetworkDefinition::domainNetwork(const QString &name) const

Returns the domain network with the specified name. Will return nullptr if no matching UtilityDomainNetwork object is found.

This function was introduced in Esri::ArcGISRuntime 100.7.

QList<Esri::ArcGISRuntime::UtilityDomainNetwork *> UtilityNetworkDefinition::domainNetworks() const

Returns the collection of domain networks in the utility network feature service.

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 function was introduced in Esri::ArcGISRuntime 100.7.

Esri::ArcGISRuntime::Envelope UtilityNetworkDefinition::extent() const

Returns the Envelope representing the service territory area used to define the UtilityNetwork.

This is the extent of the network topology (i.e., the extent of the service territory plus a small buffer).

This function was introduced in Esri::ArcGISRuntime 100.8.

Esri::ArcGISRuntime::UtilityNetworkAttribute *UtilityNetworkDefinition::networkAttribute(const QString &name) const

Returns the network attribute with the specified network attribute name.

Returns nullptr if there is no matching network attribute.

QList<Esri::ArcGISRuntime::UtilityNetworkAttribute *> UtilityNetworkDefinition::networkAttributes() const

Returns a list of utility network attributes in the utility network feature service.

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.

Esri::ArcGISRuntime::UtilityNetworkSource *UtilityNetworkDefinition::networkSource(const QString &name) const

Returns the network source with the specified network source name.

Returns nullptr if there is no matching network source.

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

Returns a list of network sources in the UtilityNetworkDefinition.

UtilityNetworkSource objects represent various sources of network information such as structures, lines, junctions, and associations.

int UtilityNetworkDefinition::schemaVersion() const

Returns the utility network schema version number reported by the utility network feature service

QList<Esri::ArcGISRuntime::UtilityTerminalConfiguration *> UtilityNetworkDefinition::terminalConfigurations() const

Returns the UtilityTerminalConfiguration objects defined for this utility network.

This function was introduced in Esri::ArcGISRuntime 100.7.


Feedback on this topic?