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

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

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

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

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

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] 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