UtilityTraceParameters

Utility network trace parameters.

Since

200.1.0

Constructors

Link copied to clipboard
constructor(namedTraceConfiguration: UtilityNamedTraceConfiguration, startingLocations: Iterable<UtilityElement>)

Constructs a new UtilityTraceParameters from a predefined trace options with the supplied starting locations.

constructor(traceType: UtilityTraceType, startingLocations: Iterable<UtilityElement>)

Constructs a new UtilityTraceParameters for the specified trace type and with the supplied starting locations.

Properties

Link copied to clipboard

The collection of barriers.

Link copied to clipboard

The collection of filter barriers. A regular barrier, specified by UtilityTraceParameters.barriers, prevents traversal which, when used with subnetwork-based traces, can prevent traversal to the subnetwork controller. Like UtilityTraceConfiguration.filter, filter barriers are evaluated in the second pass of a trace. Therefore, it can restrict the result set without impacting the ability to find subnetwork controllers from starting points.

Link copied to clipboard

A collection that is pre-populated with the default of UtilityTraceResultType.Elements; it corresponds to the UtilityTraceResult collection returned by UtilityNetwork.trace(UtilityTraceParameters).

Link copied to clipboard

The collection of starting locations.

Link copied to clipboard

The complete collection of trace options.

Link copied to clipboard

The trace type.