UtilityTraceParameters Class

Member Function Documentation

UtilityTraceParameters::UtilityTraceParameters(Esri::ArcGISRuntime::UtilityTraceType traceType, const QList<Esri::ArcGISRuntime::UtilityElement *> &startingLocations, QObject *parent = nullptr)

Constructs a new UtilityTraceParameters for the specified trace type and with the supplied starting locations.

• traceType - The type of trace to perform.
• startingLocations - The collection of starting locations.
• parent - The optional parent QObject.

[since Esri::ArcGISRuntime 100.11] UtilityTraceParameters::UtilityTraceParameters(Esri::ArcGISRuntime::UtilityNamedTraceConfiguration *namedTraceConfiguration, const QList<Esri::ArcGISRuntime::UtilityElement *> &startingLocations, QObject *parent = nullptr)

Constructs a new UtilityTraceParameters from predefined trace options with the supplied starting locations.

• namedTraceConfiguration - The UtilityNamedTraceConfiguration from which the UtilityTraceParameters object is generated.
• startingLocations - The collection of starting locations.
• parent - The optional parent QObject.

This function was introduced in Esri::ArcGISRuntime 100.11.

See also UtilityNamedTraceConfiguration.

[override virtual] UtilityTraceParameters::~UtilityTraceParameters()

Destructor.

QList<Esri::ArcGISRuntime::UtilityElement *> UtilityTraceParameters::barriers() const

Returns the collection of barriers.

Barriers are used in traces to mark the locations to stop tracing.

See also setBarriers() and UtilityElement.

[since Esri::ArcGISRuntime 100.10] QList<Esri::ArcGISRuntime::UtilityElement *> UtilityTraceParameters::filterBarriers() const

Returns the collection of filter barriers.

A regular barrier, specified by barriers, prevents traversal which, when used with subnetwork-based traces, can prevent traversal to the subnetwork controller. Like UtilityTraceConfiguration::filter, filter barriers are evaluated in the second pass of a trace. Therefore, it can restrict the result set without impacting the ability to find subnetwork controllers from starting points.

One example of where filter barriers can be used is in the gas distribution domain. Filter barriers can be used to simulate the location of a squeeze-off when executing a valve isolation trace. The user can place a filter barrier at the proposed location of the squeeze-off and then verify its impact, using a trace.

This function was introduced in Esri::ArcGISRuntime 100.10.

See also setFilterBarriers().

QList<Esri::ArcGISRuntime::UtilityTraceResultType> UtilityTraceParameters::resultTypes() const

Returns a collection that is pre-populated with the default of UtilityTraceResultType::Elements.

This corresponds to the UtilityTraceResult collection returned by UtilityNetwork::traceAsync(Esri::ArcGISRuntime::UtilityTraceParameters*, QObject*).

See also setResultTypes() and UtilityTraceResultType.

void UtilityTraceParameters::setBarriers(const QList<Esri::ArcGISRuntime::UtilityElement *> &barriers)

Sets the barriers to barriers.

See also barriers.

[since Esri::ArcGISRuntime 100.10] void UtilityTraceParameters::setFilterBarriers(const QList<Esri::ArcGISRuntime::UtilityElement *> &filterBarriers)

Sets the filterBarriers to filterBarriers.

This function was introduced in Esri::ArcGISRuntime 100.10.

See also filterBarriers.

void UtilityTraceParameters::setResultTypes(const QList<Esri::ArcGISRuntime::UtilityTraceResultType> &resultTypes)

Sets the resultTypes to resultTypes.

See also resultTypes.

void UtilityTraceParameters::setStartingLocations(const QList<Esri::ArcGISRuntime::UtilityElement *> &startingLocations)

Sets the startingLocations to startingLocations.

See also startingLocations.

[since Esri::ArcGISRuntime 100.7] void UtilityTraceParameters::setTraceConfiguration(Esri::ArcGISRuntime::UtilityTraceConfiguration *traceConfiguration)

Sets the traceConfiguration to traceConfiguration.

This function was introduced in Esri::ArcGISRuntime 100.7.

See also traceConfiguration.

QList<Esri::ArcGISRuntime::UtilityElement *> UtilityTraceParameters::startingLocations() const

Returns the list of starting locations.

A starting point defines the location in the network where a trace begins.

See also setStartingLocations() and UtilityElement.

[since Esri::ArcGISRuntime 100.7] Esri::ArcGISRuntime::UtilityTraceConfiguration *UtilityTraceParameters::traceConfiguration() const

Returns the complete collection of trace options.

This function was introduced in Esri::ArcGISRuntime 100.7.

See also setTraceConfiguration().

Esri::ArcGISRuntime::UtilityTraceType UtilityTraceParameters::traceType() const

Returns the trace type.