Skip To Content ArcGIS for Developers Sign In Dashboard

UtilityTraceParameters Class


Utility network trace parameters More...

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

Public Functions

UtilityTraceParameters(UtilityTraceType traceType, const QList<UtilityElement *> &startingLocations, QObject *parent = nullptr)
QList<UtilityElement *> barriers() const
QList<Esri::ArcGISRuntime::UtilityTraceResultType> resultTypes() const
void setBarriers(const QList<UtilityElement *> &barriers)
void setResultTypes(const QList<Esri::ArcGISRuntime::UtilityTraceResultType> &resultTypes)
void setStartingLocations(const QList<UtilityElement *> &startingLocations)
void setTraceConfiguration(UtilityTraceConfiguration *traceConfiguration)
QList<UtilityElement *> startingLocations() const
UtilityTraceConfiguration *traceConfiguration() const
UtilityTraceType traceType() const
  • 31 public functions inherited from QObject

Additional Inherited Members

Detailed Description

Utility network trace parameters

Member Function Documentation

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

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



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

Returns the list of barriers used in a trace operation.

See also setBarriers() and UtilityElement.

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

Returns the list of result types.

See also setResultTypes() and UtilityTraceResultType.

void UtilityTraceParameters::setBarriers(const QList<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::setResultTypes(const QList<Esri::ArcGISRuntime::UtilityTraceResultType> &resultTypes)

Sets the list of result types to resultTypes.

See also resultTypes().

void UtilityTraceParameters::setStartingLocations(const QList<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(UtilityTraceConfiguration *traceConfiguration)

Sets the traceConfiguration to traceConfiguration.

This function was introduced in Esri::ArcGISRuntime 100.7.

See also traceConfiguration.

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

Returns a list of starting locations to use in a trace operation.

See also setStartingLocations() and UtilityElement.

UtilityTraceConfiguration *UtilityTraceParameters::traceConfiguration() const

Returns the complete collection of trace options.

This function was introduced in Esri::ArcGISRuntime 100.7.

See also setTraceConfiguration().

UtilityTraceType UtilityTraceParameters::traceType() const

Returns the trace type.

Feedback on this topic?