Obsolete Members for UtilityNetwork

UtilityNetwork

The following members of class UtilityNetwork are deprecated. They are provided to keep old source code working. We strongly advise against using them in new code.

Public Functions

Signals

Member Function Documentation

[explicit, deprecated] UtilityNetwork::UtilityNetwork(const QUrl &url, QObject *parent = nullptr)

This function is deprecated. We strongly advise against using it in new code.

Creates a UtilityNetwork using the URL to the feature service.

• url - The URL to the feature service.
• parent - The optional parent QObject.

[deprecated] UtilityNetwork::UtilityNetwork(const QUrl &url, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)

This function is deprecated. We strongly advise against using it in new code.

Constructor that accepts a URL of the utility network feature service and a credential.

• url - The URL of the utility network feature service
• credential - The Credential used to access the service
• parent - The parent object for this UtilityNetwork (optional)

[deprecated] UtilityNetwork::UtilityNetwork(const QUrl &url, Esri::ArcGISRuntime::Map *map, QObject *parent = nullptr)

This function is deprecated. We strongly advise against using it in new code.

Creates a utility network with the URL to the feature service and a map.

• url - The URL to the Feature Service.
• map - A Map that provides FeatureTables to be reused by the utility network.
• parent - The optional parent QObject.

Creates a utility network associated with a particular service, using the same ArcGISFeatureTable objects in use by FeatureLayer objects within the map. This lets any UtilityElement or ArcGISFeature objects the UtilityNetwork creates or uses be associated with those existing tables and layers. Usually used when instantiating a UtilityNetwork object from a web map. This UtilityNetwork will be added to Map::utilityNetworks.

[deprecated] UtilityNetwork::UtilityNetwork(const QUrl &url, Esri::ArcGISRuntime::Map *map, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)

This function is deprecated. We strongly advise against using it in new code.

Constructor that accepts a URL, a Map, and a Credential.

• url - The URL of the utility network feature service
• map - A Map that provides FeatureTables to be reused by the utility network
• credential - The Credential used to access the service
• parent - The parent object for this UtilityNetwork (optional)

This constructor is used when creating a UtilityNetwork object from a web map and a credential is needed. It creates a utility network associated with a particular service, using the same ArcGISFeatureTable objects in use by FeatureLayer objects within the map. This lets any UtilityElement or ArcGISFeature objects the UtilityNetwork creates or uses be associated with those existing tables and layers.

[since Esri::ArcGISRuntime 100.7, deprecated] Esri::ArcGISRuntime::TaskWatcher UtilityNetwork::associations(Esri::ArcGISRuntime::UtilityElement *element)

This function is deprecated. We strongly advise against using it in new code.

Queries for a list of all UtilityAssociation objects present in the geodatabase for a given element.

Returns a TaskWatcher for the asynchronous operation. Connect to the associationsCompleted signal to know when the task completes.

The result is a list of all associations – connectivity associations, containment associations, structural attachment associations – that include the given UtilityElement object.

The method does not return a complete picture of connectivity; features that are connected by geometric coincidence are not returned. Note that the list returned can contain associations that have not yet been validated and are therefore not yet included in the topological index.

This function was introduced in Esri::ArcGISRuntime 100.7.

[since Esri::ArcGISRuntime 100.8, deprecated] Esri::ArcGISRuntime::TaskWatcher UtilityNetwork::associations(const Esri::ArcGISRuntime::Envelope &extent)

This function is deprecated. We strongly advise against using it in new code.

Queries for a list of all UtilityAssociation objects (with their geometry) present in the geodatabase for a given Envelope.

Returns a TaskWatcher for the asynchronous operation. Connect to the associationsCompleted signal to know when the task completes.

The result is a list of connectivity and structural attachment associations. Containment associations are not returned because no geometric relationship is defined between a container and its contents. The method does not return a complete picture of connectivity; features that are connected by geometric coincidence are not returned. Note that the list returned can contain associations that have not yet been validated and are therefore not yet included in the topological index.

• extent - The Envelope that defines the area for which associations to return.

This function was introduced in Esri::ArcGISRuntime 100.8.

[since Esri::ArcGISRuntime 100.7, deprecated] Esri::ArcGISRuntime::TaskWatcher UtilityNetwork::associations(Esri::ArcGISRuntime::UtilityElement *element, Esri::ArcGISRuntime::UtilityAssociationType type)

This function is deprecated. We strongly advise against using it in new code.

Queries for a list of all UtilityAssociation objects of type UtilityAssociationType present in the geodatabase for a given element.

Returns a TaskWatcher for the asynchronous operation. Connect to the associationsCompleted signal to know when the task completes.

The method does not return a complete picture of connectivity; features that are connected by geometric coincidence are not returned. Note that the list returned can contain associations that have not yet been validated and are therefore not yet included in the topological index.

This function was introduced in Esri::ArcGISRuntime 100.7.

[since Esri::ArcGISRuntime 100.8, deprecated] Esri::ArcGISRuntime::TaskWatcher UtilityNetwork::associations(const Esri::ArcGISRuntime::Envelope &extent, Esri::ArcGISRuntime::UtilityAssociationType type)

This function is deprecated. We strongly advise against using it in new code.

Queries for a list of all UtilityAssociation objects (with their geometry) of type UtilityAssociationType present in the geodatabase for a given Envelope.

Returns a TaskWatcher for the asynchronous operation. Connect to the associationsCompleted signal to know when the task completes.

Containment associations are not returned because no geometric relationship is defined between a container and its contents; consider using UtilityNetwork::associations(element, type) instead.

The method does not return a complete picture of connectivity; features that are connected by geometric coincidence are not returned. Note that the list returned can contain associations that have not yet been validated and are therefore not yet included in the topological index.

• extent - The Envelope that defines the area for which associations to return.
• type - The UtilityAssociationType of associations to return.

This function was introduced in Esri::ArcGISRuntime 100.8.

[signal, since Esri::ArcGISRuntime 100.7, deprecated] void UtilityNetwork::associationsCompleted(const QUuid &taskId, const QList<Esri::ArcGISRuntime::UtilityAssociation *> &associations)

This function is deprecated. We strongly advise against using it in new code.

Signal emitted when an assocations asynchronous task completes.

taskId - The task ID for the asynchronous operation. associations - The returned associations.

The returned UtilityAssociation objects have the UtilityNetwork as their parent.

This function was introduced in Esri::ArcGISRuntime 100.7.

See also Returned QObjects Parenting.

[override virtual, deprecated] Esri::ArcGISRuntime::Credential *UtilityNetwork::credential() const

This function is deprecated. We strongly advise against using it in new code.

Reimplements: RemoteResource::credential() const.

Returns the security credential used to access the utility network.

[deprecated] Esri::ArcGISRuntime::TaskWatcher UtilityNetwork::featuresForElements(const QList<Esri::ArcGISRuntime::UtilityElement *> &elements)

This function is deprecated. We strongly advise against using it in new code.

Creates a list of LoadStatus::Loaded ArcGISFeature objects where each object in the list corresponds to an item in the list of UtilityElement objects

• elements - The list of UtilityElements

The returned UtilityElement objects each have the UtilityNetwork object as their parent.

See also Returned QObjects Parenting.

[signal, deprecated] void UtilityNetwork::featuresForElementsCompleted(const QUuid &taskId)

This function is deprecated. We strongly advise against using it in new code.

Signal emitted after any of the featuresForElements asynchronous tasks completes.

• taskId - The task ID of the completed asynchronous task

[since Esri::ArcGISRuntime 100.11, deprecated] Esri::ArcGISRuntime::TaskWatcher UtilityNetwork::queryNamedTraceConfigurations(Esri::ArcGISRuntime::UtilityNamedTraceConfigurationQueryParameters *queryParameters)

This function is deprecated. We strongly advise against using it in new code.

Returns a list of UtilityNamedTraceConfiguration from the utility network.

• queryParameters - Optional query parameter to filter the results.

If none of the query parameters are set or if nullptr is passed in then all available UtilityNamedTraceConfiguration are returned.

Returns a TaskWatcher for the asynchronous operation.

{UtilityNamedTraceConfigurationQueryParameters}

This function was introduced in Esri::ArcGISRuntime 100.11.

See also Esri::ArcGISRuntime::UtilityNamedTraceConfigurationQueryParameters.

[signal, since Esri::ArcGISRuntime 100.11, deprecated] void UtilityNetwork::queryNamedTraceConfigurationsCompleted(const QUuid &taskId, const QList<Esri::ArcGISRuntime::UtilityNamedTraceConfiguration *> &utilityNamedTraceConfigurationResults)

This function is deprecated. We strongly advise against using it in new code.

Signal emitted after a queryNamedTraceConfigurations asynchronous task completes.

• taskId - The task ID of the asynchronous task.
• utilityNamedTraceConfigurationResults - The returned QList of UtilityNamedTraceConfiguration.

The returned UtilityNamedTraceConfiguration objects have the UtilityNetwork as their parent.

This function was introduced in Esri::ArcGISRuntime 100.11.

See also Returned QObjects Parenting.

[override virtual, deprecated] Esri::ArcGISRuntime::RequestConfiguration UtilityNetwork::requestConfiguration() const

This function is deprecated. We strongly advise against using it in new code.

Reimplements: RemoteResource::requestConfiguration() const.

Returns the RequestConfiguration in use by this task.

See also setRequestConfiguration().

[override virtual, deprecated] void UtilityNetwork::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration)

This function is deprecated. We strongly advise against using it in new code.

Reimplements: RemoteResource::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration).

Sets the configuration parameters used for network requests sent by this task to requestConfiguration.

See also requestConfiguration().

[deprecated] Esri::ArcGISRuntime::TaskWatcher UtilityNetwork::trace(Esri::ArcGISRuntime::UtilityTraceParameters *traceParameters)

This function is deprecated. We strongly advise against using it in new code.

Begins a trace using the supplied trace parameters.

• traceParameters - The UtilityTraceParameters to use for this trace.

Returns a Task Watcher that runs a trace and populates the traceResult list model with results.

[signal, deprecated] void UtilityNetwork::traceCompleted(const QUuid &taskId)

This function is deprecated. We strongly advise against using it in new code.

Signal emitted after a trace asynchronous task completes.

• taskId - The task ID of the asynchronous task