Skip To Content ArcGIS for Developers Sign In Dashboard

UtilityTraceFilter QML Type

A mechanism to stop tracing when returning results. UtilityTraceFilter objects do not stop traversability to the controller. More...

Import Statement: import Esri.ArcGISRuntime 100.9
Since: Esri.ArcGISRuntime 100.8
Inherits:

Object

Properties

Signals

Detailed Description

Consider an upstream protective device trace. At first, you might try defining a UtilityCategoryComparison that looks for a Protective Device category and assigning this to UtilityTraversability::barriers. When you try to run an upstream trace using this configuration, it will probably fail. This is because traversability will stop at the first protective device, and the trace will be unable to find the subnetwork controller. The correct way to implement this trace is to assign UtilityCategoryComparison to the filter.

UtilityTraceFilter objects do not stop traversability to the controller.

Property Documentation

A condition object specifying when to traverse a node or its subnodes.


bitsetNetworkAttribute : UtilityNetworkAttribute

Specifies that a UtilityNetworkAttribute stores a bitset, and this bitset should be used to filter results.


Returns a list model of UtilityTraceFunctionBarrier objects.

If any of these objects evaluates to true, further traversal is terminated.


nearestNeighbor : UtilityNearestNeighbor

A filter object specifying the next N features to be returned from the starting point.


scope : UtilityTraversabilityScope

A Enums.UtilityTraversabilityScope that determines whether traversability criteria are evaluated on edges, junctions, or both.

The default value is UtilityTraversabilityScope.JunctionsAndEdges.

See also Enums.UtilityTraversabilityScope.


Signal Documentation

barriersChanged()

Emitted when the barriers property changes.

Note: The corresponding handler is onBarriersChanged.


bitsetNetworkAttributeChanged()

Emitted when the bitsetNetworkAttribute property changes.

Note: The corresponding handler is onBitsetNetworkAttributeChanged.


nearestNeighborChanged()

Emitted when the nearestNeighbor property changes.

Note: The corresponding handler is onNearestNeighborChanged.


scopeChanged()

Emitted when the scope property changes.

Note: The corresponding handler is onScopeChanged.



Feedback on this topic?