A set of options controlling which objects are evaluated or returned during a tracing operation. More...
| Header: | #include <UtilityTraversability.h> |
| Since: | Esri::ArcGISRuntime 100.7 |
| Inherits: | Esri::ArcGISRuntime::Object |
Public Functions
| UtilityTraversability(QObject *parent = nullptr) | |
| virtual | ~UtilityTraversability() override |
| Esri::ArcGISRuntime::UtilityTraceCondition * | barriers() const |
| Esri::ArcGISRuntime::UtilityTraceFunctionBarrierListModel * | functionBarriers() |
| Esri::ArcGISRuntime::UtilityTraversabilityScope | scope() const |
| void | setBarriers(Esri::ArcGISRuntime::UtilityTraceCondition *barriers) |
| void | setScope(Esri::ArcGISRuntime::UtilityTraversabilityScope scope) |
Detailed Description
UtilityTraversability is set in the UtilityTraceConfiguration.
Relevant samples:
- Configure subnetwork trace: Get a server-defined trace configuration for a given tier and modify its traversability scope, add new condition barriers and control what is included in the subnetwork trace result.
- Create load report: Create a simple electric distribution report that displays the count of customers and total load per phase by tracing downstream from a given point.
- Trace utility network: Discover connected features in a utility network using connected, subnetwork, upstream, and downstream traces.
Member Function Documentation
[explicit] UtilityTraversability::UtilityTraversability (QObject *parent = nullptr)
Creates a UtilityTraversability object with default values.
- parent - The optional parent object.
[override virtual] UtilityTraversability::~UtilityTraversability ()
Destructor.
Esri::ArcGISRuntime::UtilityTraceCondition *UtilityTraversability::barriers() const
A condition object specifying when to traverse a node or its subnodes
See also setBarriers().
Esri::ArcGISRuntime::UtilityTraceFunctionBarrierListModel *UtilityTraversability::functionBarriers ()
A collection of UtilityTraceFunctionBarrier objects. If any of these objects evaluates to true, further traversal is terminated.
Esri::ArcGISRuntime::UtilityTraversabilityScope UtilityTraversability::scope() const
Returns whether traversability criteria are evaluated on edges, junctions, or both.
The default value is UtilityTraversabilityScope::JunctionsAndEdges.
See also setScope().
void UtilityTraversability::setBarriers (Esri::ArcGISRuntime::UtilityTraceCondition *barriers)
Sets the barriers to barriers.
See also barriers.
void UtilityTraversability::setScope (Esri::ArcGISRuntime::UtilityTraversabilityScope scope)
Sets the scope to scope.
See also scope.