Propagator objects allow a subset of UtilityNetworkAttribute values to propagate through a network while executing a trace. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.7 |
| Inherits: |
Properties
- comparisonOperator : Enums.UtilityAttributeComparisonOperator
- networkAttribute : UtilityNetworkAttribute
- propagatorFunctionType : Enums.UtilityPropagatorFunctionType
- substitutionNetworkAttribute : UtilityNetworkAttribute
- value : var
Signals
- comparisonOperatorChanged()
- networkAttributeChanged()
- propagatorFunctionTypeChanged()
- substitutionNetworkAttributeChanged()
- valueChanged()
Detailed Description
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).
UtilityPropagator is set in the UtilityTraceConfiguration.
Property Documentation
The operator that is applied when executing the trace.
This operator is used to compare the propagated value to the specified UtilityPropagator.value. For example, if propagating phase, this would be UtilityAttributeComparisonOperator::IncludesAny.
See also Enums.UtilityAttributeComparisonOperator.
networkAttribute : UtilityNetworkAttribute |
The UtilityNetworkAttribute to propagate further along the trace.
For example, if propagating phase, this would be the UtilityNetworkAttribute that stores phase.
The function type that is applied to the UtilityNetworkAttribute to propagate the attribute further along the trace.
For example, if propagating phase, this would be UtilityPropagatorFunctionType.BitwiseAnd.
See also Enums.UtilityPropagatorFunctionType.
substitutionNetworkAttribute : UtilityNetworkAttribute |
The UtilityNetworkAttribute that maps each bit in another bitset network attribute value to a new value.
The value that is compared against the propagated value when executing the trace. The type of this numeric value depends on the Enums.UtilityNetworkAttributeDataType of the UtilityNetworkAttribute.
Signal Documentation
Emitted when the comparisonOperator property changes.
Note: The corresponding handler is onComparisonOperatorChanged.
Emitted when the networkAttribute property changes.
Note: The corresponding handler is onNetworkAttributeChanged.
Emitted when the propagatorFunctionType property changes.
Note: The corresponding handler is onPropagatorFunctionTypeChanged.
Emitted when the substitutionNetworkAttribute property changes.
Note: The corresponding handler is onSubstitutionNetworkAttributeChanged.
Emitted when the value property changes.
Note: The corresponding handler is onValueChanged.