UtilityPropagator class final

Propagator objects allow a subset of UtilityNetworkAttribute values to propagate through a network while executing a trace.

The propagated UtilityNetworkAttribute values can be tested to allow or disallow further traversal.

In the example of phase propagation, open devices along the network will restrict some phases from continuing along the trace.

Propagators only apply to subnetwork-based traces (UtilityTraceType.upstream, UtilityTraceType.downstream, and so on).

Implemented types

Constructors

UtilityPropagator({required UtilityNetworkAttribute networkAttribute, required UtilityPropagatorFunctionType propagatorFunctionType, required UtilityAttributeComparisonOperator comparisonOperator, required dynamic value, UtilityNetworkAttribute? substitutionAttribute}): Creates an object that allows a subset of UtilityNetworkAttribute values to propagate through a network.
factory

comparisonOperator → UtilityAttributeComparisonOperator: The operator that is applied when executing the trace.
no setter
hashCode → int: The hash code for this object.
no setterinherited
networkAttribute → UtilityNetworkAttribute: The UtilityNetworkAttribute to propagate further along the trace.
no setter
propagatorFunctionType → UtilityPropagatorFunctionType: The function type that is applied to the UtilityNetworkAttribute to propagate the attribute further along the trace.
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
substitutionNetworkAttribute → UtilityNetworkAttribute?: The UtilityNetworkAttribute that maps each bit in another bitset network attribute value to a new value.
no setter
value → dynamic: The value that is compared against the propagated value when executing the trace.
no setter

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