UtilityTraceFilter class final

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

Consider an upstream protective device trace. At first, you might try defining an 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 is set in the UtilityTraceConfiguration

Implemented types

Constructors

UtilityTraceFilter()
Creates an UtilityTraceFilter object with default values.
factory

Properties

barriers ↔ UtilityTraceCondition?
A condition object specifying when to traverse a node or its subnodes.
getter/setter pair
bitsetNetworkAttribute ↔ UtilityNetworkAttribute?
Specifies that an UtilityNetworkAttribute stores a bitset, and this bitset should be used to filter results.
getter/setter pair
functionBarriers → List<UtilityTraceFunctionBarrier>
A collection of UtilityTraceFunctionBarrier objects. If any of these objects evaluates to true, further traversal is terminated.
no setter
hashCode → int
The hash code for this object.
no setterinherited
nearestNeighbor ↔ UtilityNearestNeighbor?
A filter object specifying the next N features to be returned from the starting point.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scope ↔ UtilityTraversabilityScope
Determines whether traversability criteria are evaluated on edges, junctions, or both.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited