ArcGIS Runtime SDK for iOS
100.15
|
Utility network trace parameters.
Instance Methods | |
(instancetype) | - initWithNamedTraceConfiguration:startingLocations: |
(instancetype) | - initWithTraceType:startingLocations: |
Class Methods | |
(instancetype) | + utilityTraceParametersWithNamedTraceConfiguration:startingLocations: |
(instancetype) | + utilityTraceParametersWithTraceType:startingLocations: |
Properties | |
NSArray< AGSUtilityElement * > * | barriers |
NSArray< AGSUtilityElement * > * | filterBarriers |
NSArray< NSValue * > * | resultTypes |
NSArray< AGSUtilityElement * > * | startingLocations |
AGSUtilityTraceConfiguration * | traceConfiguration |
AGSUtilityTraceType | traceType |
- (instancetype) initWithNamedTraceConfiguration: | (AGSUtilityNamedTraceConfiguration *) | namedTraceConfiguration | |
startingLocations: | (NSArray< AGSUtilityElement * > *) | startingLocations | |
Creates a new AGSUtilityTraceParameters
object from pre-defined trace options with the supplied starting locations.
namedTraceConfiguration | The AGSUtilityNamedTraceConfiguration object from which the AGSUtilityTraceParameters object is generated. |
startingLocations | An array of starting locations. |
- (instancetype) initWithTraceType: | (AGSUtilityTraceType) | traceType | |
startingLocations: | (NSArray< AGSUtilityElement * > *) | startingLocations | |
Creates a new AGSUtilityTraceParameters
object for the specified trace type and with the supplied starting locations.
traceType | The type of trace to perform. |
startingLocations | The array of starting locations. |
+ (instancetype) utilityTraceParametersWithNamedTraceConfiguration: | (AGSUtilityNamedTraceConfiguration *) | namedTraceConfiguration | |
startingLocations: | (NSArray< AGSUtilityElement * > *) | startingLocations | |
Creates a new AGSUtilityTraceParameters
object from pre-defined trace options with the supplied starting locations.
namedTraceConfiguration | The AGSUtilityNamedTraceConfiguration object from which the AGSUtilityTraceParameters object is generated. |
startingLocations | An array of starting locations. |
AGSUtilityTraceParameters
object. + (instancetype) utilityTraceParametersWithTraceType: | (AGSUtilityTraceType) | traceType | |
startingLocations: | (NSArray< AGSUtilityElement * > *) | startingLocations | |
Creates a new AGSUtilityTraceParameters
object for the specified trace type and with the supplied starting locations.
traceType | The type of trace to perform. |
startingLocations | The array of starting locations. |
AGSUtilityTraceParameters
object.
|
readwritenonatomiccopy |
The array of barriers.
|
readwritenonatomiccopy |
The array of filter barriers.
A regular barrier, specified by the AGSUtilityTraceParameters::barriers
property, prevents traversal which, when used with subnetwork-based traces, can prevent traversal to the subnetwork controller. Like the AGSUtilityTraceConfiguration::filter
property, filter barriers are evaluated in the second pass of a trace. Therefore, it can restrict the result set without impacting the ability to find subnetwork controllers from starting points.
One example of where filter barriers can be used is in the gas distribution domain. Filter barriers can be used to simulate the location of a squeeze-off when executing a valve isolation trace. The user can place a filter barrier at the proposed location of the squeeze-off and then verify its impact using a trace.
|
readwritenonatomiccopy |
An array of NSValue
objects containing cases of AGSUtilityTraceResultType
. The default is a single value containing AGSUtilityTraceResultTypeElements
.
|
readwritenonatomiccopy |
The array of starting locations.
|
readwritenonatomicstrong |
The complete collection of trace options.
|
readnonatomicassign |
The trace type.