ArcGIS Runtime SDK for iOS
100.15
|
Propagator objects allow a subset of AGSUtilityNetworkAttribute
values to propagate through a network while executing a trace.
The propagated AGSUtilityNetworkAttribute
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 (AGSUtilityTraceTypeUpstream
, AGSUtilityTraceTypeDownstream
, and so on).
AGSUtilityPropagator
is set in the AGSUtilityTraceConfiguration
.
Instance Methods | |
(instancetype) | - initWithNetworkAttribute:propagatorFunctionType:comparisonOperator:value: |
(instancetype) | - initWithNetworkAttribute:propagatorFunctionType:comparisonOperator:value:substitutionAttribute: |
Class Methods | |
(instancetype) | + utilityPropagatorWithNetworkAttribute:propagatorFunctionType:comparisonOperator:value: |
(instancetype) | + utilityPropagatorWithNetworkAttribute:propagatorFunctionType:comparisonOperator:value:substitutionAttribute: |
- (instancetype) initWithNetworkAttribute: | (AGSUtilityNetworkAttribute *) | networkAttribute | |
propagatorFunctionType: | (AGSUtilityPropagatorFunctionType) | propagatorFunctionType | |
comparisonOperator: | (AGSUtilityAttributeComparisonOperator) | comparisonOperator | |
value: | (id) | value | |
Creates an AGSUtilityPropagator
object that allows a subset of AGSUtilityNetworkAttribute
values to propagate through a network.
networkAttribute | The AGSUtilityNetworkAttribute object to propagate further along the trace. |
propagatorFunctionType | The function type that is applied to the AGSUtilityNetworkAttribute object to propagate the attribute further along the trace. |
comparisonOperator | The filter operator that is applied when executing the trace. This operator is used to compare the propagated value to the specified AGSUtilityPropagator::value property. |
value | The value that is compared against the propagated value when executing the trace. |
- (instancetype) initWithNetworkAttribute: | (AGSUtilityNetworkAttribute *) | networkAttribute | |
propagatorFunctionType: | (AGSUtilityPropagatorFunctionType) | propagatorFunctionType | |
comparisonOperator: | (AGSUtilityAttributeComparisonOperator) | comparisonOperator | |
value: | (id) | value | |
substitutionAttribute: | (AGSUtilityNetworkAttribute *) | substitutionAttribute | |
Creates an AGSUtilityPropagator
object that allows a subset of AGSUtilityNetworkAttribute
values to propagate through a network. This constructor allows the specification of a substitution network attribute.
networkAttribute | The AGSUtilityNetworkAttribute object to propagate further along the trace. |
propagatorFunctionType | The function type that is applied to the AGSUtilityNetworkAttribute object to propagate the attribute further along the trace. |
comparisonOperator | The filter operator that is applied when executing the trace. This operator is used to compare the propagated value to the specified AGSUtilityPropagator::value property. |
value | The value that is compared against the propagated value when executing the trace. |
substitutionAttribute | An AGSUtilityNetworkAttribute object that maps each bit in another bitset network attribute value to a new value. |
+ (instancetype) utilityPropagatorWithNetworkAttribute: | (AGSUtilityNetworkAttribute *) | networkAttribute | |
propagatorFunctionType: | (AGSUtilityPropagatorFunctionType) | propagatorFunctionType | |
comparisonOperator: | (AGSUtilityAttributeComparisonOperator) | comparisonOperator | |
value: | (id) | value | |
Creates an AGSUtilityPropagator
object that allows a subset of AGSUtilityNetworkAttribute
values to propagate through a network.
networkAttribute | The AGSUtilityNetworkAttribute object to propagate further along the trace. |
propagatorFunctionType | The function type that is applied to the AGSUtilityNetworkAttribute object to propagate the attribute further along the trace. |
comparisonOperator | The filter operator that is applied when executing the trace. This operator is used to compare the propagated value to the specified AGSUtilityPropagator::value property. |
value | The value that is compared against the propagated value when executing the trace. |
AGSUtilityPropagator
object. + (instancetype) utilityPropagatorWithNetworkAttribute: | (AGSUtilityNetworkAttribute *) | networkAttribute | |
propagatorFunctionType: | (AGSUtilityPropagatorFunctionType) | propagatorFunctionType | |
comparisonOperator: | (AGSUtilityAttributeComparisonOperator) | comparisonOperator | |
value: | (id) | value | |
substitutionAttribute: | (AGSUtilityNetworkAttribute *) | substitutionAttribute | |
Creates an AGSUtilityPropagator
object that allows a subset of AGSUtilityNetworkAttribute
values to propagate through a network This constructor allows the specification of a substitution network attribute.
networkAttribute | The AGSUtilityNetworkAttribute object to propagate further along the trace. |
propagatorFunctionType | The function type that is applied to the AGSUtilityNetworkAttribute object to propagate the attribute further along the trace. |
comparisonOperator | The filter operator that is applied when executing the trace. This operator is used to compare the propagated value to the specified AGSUtilityPropagator::value property. |
value | The value that is compared against the propagated value when executing the trace. |
substitutionAttribute | An AGSUtilityNetworkAttribute object that maps each bit in another bitset network attribute value to a new value. |
AGSUtilityPropagator
object.
|
readnonatomicassign |
The operator that is applied when executing the trace. This operator is used to compare the propagated value to the specified AGSUtilityPropagator::value
property. For example, if propagating phase, this would be AGSUtilityAttributeComparisonOperatorIncludesAny
.
|
readnonatomicstrong |
The AGSUtilityNetworkAttribute
object to propagate further along the trace. For example, if propagating phase, this would be the AGSUtilityNetworkAttribute
object that stores phase.
|
readnonatomicassign |
The function type that is applied to the AGSUtilityNetworkAttribute
object to propagate the attribute further along the trace. For example, if propagating phase, this would be AGSUtilityPropagatorFunctionTypeBitwiseAnd
.
|
readnonatomicstrong |
The AGSUtilityNetworkAttribute
object that maps each bit in another bitset network attribute value to a new value.
|
readnonatomicstrong |
The value that is compared against the propagated value when executing the trace.