UtilityTraceFilter

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

Since

200.1.0

Constructors

Link copied to clipboard
constructor()

Creates an UtilityTraceFilter object with default values.

Properties

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Determines whether traversability criteria are evaluated on edges, junctions, or both. The default value is UtilityTraversabilityScope.JunctionsAndEdges.