ArcGIS Runtime SDK for iOS: AGSUtilityTraceParameters.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSUtilityTraceParameters.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2021 ESRI
3 
4  All rights reserved under the copyright laws of the United States
5  and applicable international laws, treaties, and conventions.
6 
7  This material is licensed for use under the Esri Master License
8  Agreement (MLA), and is bound by the terms of that agreement.
9  You may redistribute and use this code without modification,
10  provided you adhere to the terms of the MLA and include this
11  copyright notice.
12 
13  See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
14 
15  For additional information, contact:
16  Environmental Systems Research Institute, Inc.
17  Attn: Contracts and Legal Services Department
18  380 New York Street
19  Redlands, California, 92373
20  USA
21 
22  email: contracts@esri.com
23  */
24  //Required for Globals API doc
26 
27 #import <Foundation/Foundation.h>
28 #import <ArcGIS/AGSObject.h>
29 
30 
31 
36 typedef NS_ENUM(NSInteger, AGSUtilityMinimumStartingLocations) {
39 };
40 
46 typedef NS_ENUM(NSInteger, AGSUtilityTraceType) {
54 };
55 
56 @class AGSUtilityElement;
59 
65 
66 #pragma mark -
67 #pragma mark initializers
68 
69 
70 
77 -(instancetype)initWithTraceType:(AGSUtilityTraceType)traceType
78  startingLocations:(NSArray<AGSUtilityElement *> *)startingLocations;
79 
87 +(instancetype)utilityTraceParametersWithTraceType:(AGSUtilityTraceType)traceType
88  startingLocations:(NSArray<AGSUtilityElement *> *)startingLocations;
89 
90 
98 - (instancetype)initWithNamedTraceConfiguration:(AGSUtilityNamedTraceConfiguration *)namedTraceConfiguration
99  startingLocations:(NSArray<AGSUtilityElement *> *)startingLocations;
100 
109 + (instancetype)utilityTraceParametersWithNamedTraceConfiguration:(AGSUtilityNamedTraceConfiguration *)namedTraceConfiguration
110  startingLocations:(NSArray<AGSUtilityElement *> *)startingLocations;
111 
112 #pragma mark -
113 #pragma mark properties
114 
118 @property (nonatomic, copy, readwrite) NSArray<AGSUtilityElement *> *barriers;
119 
128 @property (nonatomic, copy, readwrite) NSArray<AGSUtilityElement *> *filterBarriers;
129 
134 @property (nonatomic, copy, readwrite) NSArray<NSValue *> *resultTypes;
135 
139 @property (nonatomic, copy, readwrite) NSArray<AGSUtilityElement *> *startingLocations;
140 
144 @property (nullable, nonatomic, strong, readwrite) AGSUtilityTraceConfiguration *traceConfiguration;
145 
149 @property (nonatomic, assign, readonly) AGSUtilityTraceType traceType;
150 
151 #pragma mark -
152 #pragma mark methods
153 
154 @end
155 
156 
AGSUtilityMinimumStartingLocations
Definition: AGSUtilityTraceParameters.h:36
@ AGSUtilityMinimumStartingLocationsMany
Definition: AGSUtilityTraceParameters.h:38
@ AGSUtilityMinimumStartingLocationsOne
Definition: AGSUtilityTraceParameters.h:37
AGSUtilityTraceType
Definition: AGSUtilityTraceParameters.h:46
@ AGSUtilityTraceTypeConnected
Definition: AGSUtilityTraceParameters.h:47
@ AGSUtilityTraceTypeShortestPath
Definition: AGSUtilityTraceParameters.h:53
@ AGSUtilityTraceTypeLoops
Definition: AGSUtilityTraceParameters.h:52
@ AGSUtilityTraceTypeDownstream
Definition: AGSUtilityTraceParameters.h:50
@ AGSUtilityTraceTypeUpstream
Definition: AGSUtilityTraceParameters.h:49
@ AGSUtilityTraceTypeIsolation
Definition: AGSUtilityTraceParameters.h:51
@ AGSUtilityTraceTypeSubnetwork
Definition: AGSUtilityTraceParameters.h:48
Definition: AGSObject.h:28
An entity in a utility network that corresponds to an AGSFeature object.
Definition: AGSUtilityElement.h:43
A set of predefined trace options that can be used by the AGSUtilityTraceParameters object to simplif...
Definition: AGSUtilityNamedTraceConfiguration.h:46
The set of utility network parameters that define elements of a trace or of a subnetwork....
Definition: AGSUtilityTraceConfiguration.h:47
Utility network trace parameters.
Definition: AGSUtilityTraceParameters.h:65
NSArray< AGSUtilityElement * > * filterBarriers
Definition: AGSUtilityTraceParameters.h:128
NSArray< AGSUtilityElement * > * barriers
Definition: AGSUtilityTraceParameters.h:118
AGSUtilityTraceType traceType
Definition: AGSUtilityTraceParameters.h:149
NSArray< NSValue * > * resultTypes
Definition: AGSUtilityTraceParameters.h:134
NSArray< AGSUtilityElement * > * startingLocations
Definition: AGSUtilityTraceParameters.h:139
AGSUtilityTraceConfiguration * traceConfiguration
Definition: AGSUtilityTraceParameters.h:144