ArcGIS Developers
Dashboard

UtilityTraceParameters Class

class Esri::ArcGISRuntime::UtilityTraceParameters

Utility network trace parameters. More...

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

This class was introduced in Esri::ArcGISRuntime 100.6.

Public Functions

UtilityTraceParameters(Esri::ArcGISRuntime::UtilityTraceType traceType, const QList<Esri::ArcGISRuntime::UtilityElement *> &startingLocations, QObject *parent = nullptr)
virtual ~UtilityTraceParameters() override
QList<Esri::ArcGISRuntime::UtilityElement *> barriers() const
QList<Esri::ArcGISRuntime::UtilityElement *> filterBarriers() const
QList<Esri::ArcGISRuntime::UtilityTraceResultType> resultTypes() const
void setBarriers(const QList<Esri::ArcGISRuntime::UtilityElement *> &barriers)
void setFilterBarriers(const QList<Esri::ArcGISRuntime::UtilityElement *> &filterBarriers)
void setResultTypes(const QList<Esri::ArcGISRuntime::UtilityTraceResultType> &resultTypes)
void setStartingLocations(const QList<Esri::ArcGISRuntime::UtilityElement *> &startingLocations)
void setTraceConfiguration(Esri::ArcGISRuntime::UtilityTraceConfiguration *traceConfiguration)
QList<Esri::ArcGISRuntime::UtilityElement *> startingLocations() const
Esri::ArcGISRuntime::UtilityTraceConfiguration *traceConfiguration() const
Esri::ArcGISRuntime::UtilityTraceType traceType() const

Detailed Description

Member Function Documentation

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

Constructor that takes a traceType, list of startingLocations and an optional parent.

[override virtual] UtilityTraceParameters::~UtilityTraceParameters()

Destructor.

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

Returns the list of barriers used in a trace operation.

See also setBarriers() and UtilityElement.

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 server default of UtilityTraceResultType::Elements. This corresponds to the UtilityTraceResult collection returned by UtilityNetwork::trace.

See also setResultTypes() and UtilityTraceResultType.

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

Sets the list of barriers to be used in a trace operation.

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

See also barriers().

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 list of result types to resultTypes.

See also resultTypes().

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

Sets list of starting location to be used in a trace operation to startingLocations.

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

See also startingLocations().

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 a list of starting locations to use in a trace operation.

See also setStartingLocations() and UtilityElement.

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.


Feedback on this topic?