ArcGIS Runtime SDK for iOS: AGSUtilityTraceParameters Class Reference
ArcGIS Runtime SDK for iOS  100.13
AGSUtilityTraceParameters Class Reference

Description

Utility network trace parameters.

Since
100.6
Inheritance diagram for AGSUtilityTraceParameters:
AGSObject

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
 
AGSUtilityTraceConfigurationtraceConfiguration
 
AGSUtilityTraceType traceType
 

Method Documentation

◆ initWithNamedTraceConfiguration:startingLocations:

- (instancetype) initWithNamedTraceConfiguration: (AGSUtilityNamedTraceConfiguration *)  namedTraceConfiguration
startingLocations: (NSArray< AGSUtilityElement * > *)  startingLocations 

Creates a new AGSUtilityTraceParameters object from pre-defined trace options with the supplied starting locations.

Parameters
namedTraceConfigurationThe AGSUtilityNamedTraceConfiguration object from which the AGSUtilityTraceParameters object is generated.
startingLocationsAn array of starting locations.
See also
AGSUtilityNamedTraceConfiguration
Since
100.11

◆ initWithTraceType:startingLocations:

- (instancetype) initWithTraceType: (AGSUtilityTraceType traceType
startingLocations: (NSArray< AGSUtilityElement * > *)  startingLocations 

Creates a new AGSUtilityTraceParameters object for the specified trace type and with the supplied starting locations.

Parameters
traceTypeThe type of trace to perform.
startingLocationsThe array of starting locations.
Since
100.6

◆ utilityTraceParametersWithNamedTraceConfiguration:startingLocations:

+ (instancetype) utilityTraceParametersWithNamedTraceConfiguration: (AGSUtilityNamedTraceConfiguration *)  namedTraceConfiguration
startingLocations: (NSArray< AGSUtilityElement * > *)  startingLocations 

Creates a new AGSUtilityTraceParameters object from pre-defined trace options with the supplied starting locations.

Parameters
namedTraceConfigurationThe AGSUtilityNamedTraceConfiguration object from which the AGSUtilityTraceParameters object is generated.
startingLocationsAn array of starting locations.
Returns
A new AGSUtilityTraceParameters object.
See also
AGSUtilityNamedTraceConfiguration
Since
100.11

◆ utilityTraceParametersWithTraceType:startingLocations:

+ (instancetype) utilityTraceParametersWithTraceType: (AGSUtilityTraceType traceType
startingLocations: (NSArray< AGSUtilityElement * > *)  startingLocations 

Creates a new AGSUtilityTraceParameters object for the specified trace type and with the supplied starting locations.

Parameters
traceTypeThe type of trace to perform.
startingLocationsThe array of starting locations.
Returns
A new AGSUtilityTraceParameters object.
Since
100.6

Property Documentation

◆ barriers

- (NSArray<AGSUtilityElement *>*) barriers
readwritenonatomiccopy

The array of barriers.

Since
100.6

◆ filterBarriers

- (NSArray<AGSUtilityElement *>*) filterBarriers
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.

Since
100.10

◆ resultTypes

- (NSArray<NSValue *>*) resultTypes
readwritenonatomiccopy

An array of NSValue objects containing cases of AGSUtilityTraceResultType. The default is a single value containing AGSUtilityTraceResultTypeElements.

Since
100.6

◆ startingLocations

- (NSArray<AGSUtilityElement *>*) startingLocations
readwritenonatomiccopy

The array of starting locations.

Since
100.6

◆ traceConfiguration

- (AGSUtilityTraceConfiguration*) traceConfiguration
readwritenonatomicstrong

The complete collection of trace options.

Since
100.7

◆ traceType

- (AGSUtilityTraceType) traceType
readnonatomicassign

The trace type.

Since
100.6