UtilityTraceConfiguration class final

The set of utility network parameters that define elements of a trace or of a subnetwork.

UtilityTraceConfiguration is set in the UtilityTraceParameters.

Implemented types

Constructors

UtilityTraceConfiguration()
Creates an UtilityTraceConfiguration with default values.
factory

Properties

allowIndeterminateFlow ↔ bool
True to allow tracing across network features with indeterminate flow or false to stop the traversal when indeterminate flow is encountered.
getter/setter pair
domainNetwork ↔ UtilityDomainNetwork?
The UtilityDomainNetwork from which to start the trace.
getter/setter pair
filter ↔ UtilityTraceFilter?
The criteria that define the dynamic barriers for the trace.
getter/setter pair
functions → List<UtilityTraceFunction>
A collection of UtilityTraceFunction objects to compute while performing the trace.
no setter
hashCode → int
The hash code for this object.
no setterinherited
ignoreBarriersAtStartingPoints ↔ bool
Indicates whether to ignore barriers at starting points.
getter/setter pair
includeBarriers ↔ bool
Whether to include barriers in the trace results or subnetwork.
getter/setter pair
includeContainers ↔ bool
Whether to include containment features in the trace results or subnetwork.
getter/setter pair
includeContent ↔ bool
Whether to include content in the trace results or subnetwork.
getter/setter pair
includeIsolatedFeatures ↔ bool
Whether to include isolated features in the trace results when used in conjunction with an isolation trace.
getter/setter pair
includeStructures ↔ bool
Whether to include structure features in the trace results or subnetwork.
getter/setter pair
includeUpToFirstSpatialContainer ↔ bool
True to include containment associations up to and including the first spatial container or false to include all containment associations.
getter/setter pair
outputAssetTypes → List<UtilityAssetType>
A collection of UtilityAssetType objects which specifies what to include in the trace results.
no setter
outputCondition ↔ UtilityTraceCondition?
A condition object which specifies what to include in the trace results.
getter/setter pair
propagators → List<UtilityPropagator>
A collection of UtilityPropagator objects to execute while performing the trace.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shortestPathNetworkAttribute ↔ UtilityNetworkAttribute?
The UtilityNetworkAttribute used to calculate the shortest path.
getter/setter pair
sourceTier ↔ UtilityTier?
The UtilityTier that is used as the start of the trace.
getter/setter pair
targetTier ↔ UtilityTier?
The UtilityTier that is used to constrain the tiers returned by the upstream and downstream traces.
getter/setter pair
traversability ↔ UtilityTraversability?
The traversability conditions for the trace.
getter/setter pair
useDigitizedDirection ↔ bool
True if the trace uses the flow direction, false otherwise.
getter/setter pair
validateConsistency ↔ bool
Indicates whether to validate network consistency as part of the trace operation.
getter/setter pair
validateLocatability ↔ bool
True to fail trace operations if non-spatial objects are encountered without the necessary containment, attachment, or connectivity association to a spatial object, or false to allow tracing of those non-spatial objects.
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