ArcGIS Runtime SDK for iOS: AGSUtilityPropagator Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSUtilityPropagator Class Reference

Description

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.

Since
100.7
Inheritance diagram for AGSUtilityPropagator:
AGSObject

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:
 

Properties

AGSUtilityAttributeComparisonOperator comparisonOperator
 
AGSUtilityNetworkAttributenetworkAttribute
 
AGSUtilityPropagatorFunctionType propagatorFunctionType
 
AGSUtilityNetworkAttributesubstitutionNetworkAttribute
 
id value
 

Method Documentation

◆ initWithNetworkAttribute:propagatorFunctionType:comparisonOperator:value:

- (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.

Parameters
networkAttributeThe AGSUtilityNetworkAttribute object to propagate further along the trace.
propagatorFunctionTypeThe function type that is applied to the AGSUtilityNetworkAttribute object to propagate the attribute further along the trace.
comparisonOperatorThe filter operator that is applied when executing the trace. This operator is used to compare the propagated value to the specified AGSUtilityPropagator::value property.
valueThe value that is compared against the propagated value when executing the trace.
Since
100.7

◆ initWithNetworkAttribute:propagatorFunctionType:comparisonOperator:value:substitutionAttribute:

- (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.

Parameters
networkAttributeThe AGSUtilityNetworkAttribute object to propagate further along the trace.
propagatorFunctionTypeThe function type that is applied to the AGSUtilityNetworkAttribute object to propagate the attribute further along the trace.
comparisonOperatorThe filter operator that is applied when executing the trace. This operator is used to compare the propagated value to the specified AGSUtilityPropagator::value property.
valueThe value that is compared against the propagated value when executing the trace.
substitutionAttributeAn AGSUtilityNetworkAttribute object that maps each bit in another bitset network attribute value to a new value.
Since
100.7

◆ utilityPropagatorWithNetworkAttribute:propagatorFunctionType:comparisonOperator: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.

Parameters
networkAttributeThe AGSUtilityNetworkAttribute object to propagate further along the trace.
propagatorFunctionTypeThe function type that is applied to the AGSUtilityNetworkAttribute object to propagate the attribute further along the trace.
comparisonOperatorThe filter operator that is applied when executing the trace. This operator is used to compare the propagated value to the specified AGSUtilityPropagator::value property.
valueThe value that is compared against the propagated value when executing the trace.
Returns
A new AGSUtilityPropagator object.
Since
100.7

◆ utilityPropagatorWithNetworkAttribute:propagatorFunctionType:comparisonOperator:value:substitutionAttribute:

+ (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.

Parameters
networkAttributeThe AGSUtilityNetworkAttribute object to propagate further along the trace.
propagatorFunctionTypeThe function type that is applied to the AGSUtilityNetworkAttribute object to propagate the attribute further along the trace.
comparisonOperatorThe filter operator that is applied when executing the trace. This operator is used to compare the propagated value to the specified AGSUtilityPropagator::value property.
valueThe value that is compared against the propagated value when executing the trace.
substitutionAttributeAn AGSUtilityNetworkAttribute object that maps each bit in another bitset network attribute value to a new value.
Returns
A new AGSUtilityPropagator object.
Since
100.7

Property Documentation

◆ comparisonOperator

- (AGSUtilityAttributeComparisonOperator) comparisonOperator
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.

Since
100.7

◆ networkAttribute

- (AGSUtilityNetworkAttribute*) networkAttribute
readnonatomicstrong

The AGSUtilityNetworkAttribute object to propagate further along the trace. For example, if propagating phase, this would be the AGSUtilityNetworkAttribute object that stores phase.

Since
100.7

◆ propagatorFunctionType

- (AGSUtilityPropagatorFunctionType) propagatorFunctionType
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.

Since
100.7

◆ substitutionNetworkAttribute

- (AGSUtilityNetworkAttribute*) substitutionNetworkAttribute
readnonatomicstrong

The AGSUtilityNetworkAttribute object that maps each bit in another bitset network attribute value to a new value.

Since
100.7

◆ value

- (id) value
readnonatomicstrong

The value that is compared against the propagated value when executing the trace.

Since
100.7