UtilityNetworkDefinition Class

Member Function Documentation

[override virtual] UtilityNetworkDefinition::~UtilityNetworkDefinition()

Destructor.

[since Esri::ArcGISRuntime 200.0] Esri::ArcGISRuntime::UtilityNetworkCapabilities *UtilityNetworkDefinition::capabilities() const

Returns a value indicating the supported utility network capabilities. Use this property to determine which operations are available for this utility network.

This function was introduced in Esri::ArcGISRuntime 200.0.

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

Returns a list of utility network categories in the utility network metadata.

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.

[since Esri::ArcGISRuntime 100.7] 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.

[since Esri::ArcGISRuntime 100.7] QList<Esri::ArcGISRuntime::UtilityDomainNetwork *> UtilityNetworkDefinition::domainNetworks() const

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

This function was introduced in Esri::ArcGISRuntime 100.7.

[since Esri::ArcGISRuntime 100.8] 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 metadata.

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.

[since Esri::ArcGISRuntime 200.1] Esri::ArcGISRuntime::TaskWatcher UtilityNetworkDefinition::rules(const QList<Esri::ArcGISRuntime::UtilityAssetType *> &assetTypes)

Queries for a subset of UtilityRule objects that apply to a set of UtilityAssetType.

• assetTypes - The collection of UtilityAssetType objects to query applicable UtilityRule objects.

Use this method to return network rules applicable to features of specific asset types. Limiting these asset types to those features being edited can substantially reduce the number of network rules returned.

These asset types will be matched against the UtilityRuleElement::assetType of the following rule elements:

• UtilityRule::fromElement
• UtilityRule::toElement
• UtilityRule::viaElement

If the collection of UtilityAssetType is empty or no matching rules are found for these asset types, an empty collection of UtilityRule objects is returned.

This method returns a TaskWatcher for the asynchronous operation. Connect to the rulesCompleted signal to know when the task completes.

This function was introduced in Esri::ArcGISRuntime 200.1.

See also UtilityAssetType.

[since Esri::ArcGISRuntime 200.2] QFuture<QList<Esri::ArcGISRuntime::UtilityRule *>> UtilityNetworkDefinition::rulesAsync(const QList<Esri::ArcGISRuntime::UtilityAssetType *> &assetTypes, QObject *parent = nullptr)

Queries for a subset of UtilityRule objects that apply to a set of UtilityAssetType.

• assetTypes - The collection of UtilityAssetType objects to query applicable UtilityRule objects.
• parent - An optional parent.

Use this method to return network rules applicable to features of specific asset types. Limiting these asset types to those features being edited can substantially reduce the number of network rules returned.

These asset types will be matched against the UtilityRuleElement::assetType of the following rule elements:

• UtilityRule::fromElement
• UtilityRule::toElement
• UtilityRule::viaElement

If the collection of UtilityAssetType is empty or no matching rules are found for these asset types, an empty collection of UtilityRule objects is returned.

This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.2.

See also UtilityAssetType.

[signal, since Esri::ArcGISRuntime 200.1] void UtilityNetworkDefinition::rulesCompleted(const QUuid &taskId, const QList<Esri::ArcGISRuntime::UtilityRule *> &utilityRuleResult)

Signal emitted when the rules operation completes.

• taskId - The task ID of the asynchronous operation.
• utilityRuleResult - The returned rules.

The returned UtilityRule objects have the UtilityNetworkDefinition as their parent.

This function was introduced in Esri::ArcGISRuntime 200.1.

See also Returned QObjects Parenting.

int UtilityNetworkDefinition::schemaVersion() const

Returns the utility network schema version number reported by the utility network metadata.

[since Esri::ArcGISRuntime 100.7] 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.