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

Description

A mechanism to stop tracing when returning results. AGSUtilityTraceFilter objects do not stop traversability to the controller. Consider an upstream protective device trace. At first, you might try defining an AGSUtilityCategoryComparison object that looks for a protective device category and assigning this to the AGSUtilityTraversability::barriers property. When you try to run an upstream trace using this configuration, it will probably fail. This is because traversability will stop at the first protective device, and the trace will be unable to find the subnetwork controller. The correct way to implement this trace is to assign the AGSUtilityCategoryComparison object to the filter. AGSUtilityTraceFilter is set in the AGSUtilityTraceConfiguration object.

Since
100.8
Inheritance diagram for AGSUtilityTraceFilter:
AGSObject

Instance Methods

(instancetype) - init
 

Class Methods

(instancetype) + utilityTraceFilter
 

Properties

AGSUtilityTraceConditionbarriers
 
AGSUtilityNetworkAttributebitsetNetworkAttribute
 
NSArray< AGSUtilityTraceFunctionBarrier * > * functionBarriers
 
AGSUtilityNearestNeighbornearestNeighbor
 
AGSUtilityTraversabilityScope scope
 

Method Documentation

◆ init

- (instancetype) init

Creates an AGSUtilityTraceFilter object with default values.

Since
100.8

◆ utilityTraceFilter

+ (instancetype) utilityTraceFilter

Creates an AGSUtilityTraceFilter object with default values.

Returns
A new AGSUtilityTraceFilter object.
Since
100.8

Property Documentation

◆ barriers

- (AGSUtilityTraceCondition*) barriers
readwritenonatomicstrong

A condition object specifying when to traverse a node or its subnodes.

Since
100.8

◆ bitsetNetworkAttribute

- (AGSUtilityNetworkAttribute*) bitsetNetworkAttribute
readwritenonatomicstrong

Specifies that an AGSUtilityNetworkAttribute object stores a bitset, and this bitset should be used to filter results.

Since
100.8

◆ functionBarriers

- (NSArray<AGSUtilityTraceFunctionBarrier *>*) functionBarriers
readwritenonatomiccopy

An array of AGSUtilityTraceFunctionBarrier objects. If any of these objects evaluates to YES, further traversal is terminated.

Since
100.8

◆ nearestNeighbor

- (AGSUtilityNearestNeighbor*) nearestNeighbor
readwritenonatomicstrong

A filter object specifying the next N features to be returned from the starting point.

Since
100.8

◆ scope

- (AGSUtilityTraversabilityScope) scope
readwritenonatomicassign

Determines whether traversability criteria are evaluated on edges, junctions, or both. The default value is AGSUtilityTraversabilityScopeJunctionsAndEdges.

Since
100.8