ArcGIS Runtime SDK for iOS: AGSServiceAreaParameters.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSServiceAreaParameters.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 
25 #import <Foundation/Foundation.h>
26 #import <ArcGIS/AGSObject.h>
27 #import <ArcGIS/AGSRouteTypes.h>
28 #import <ArcGIS/AGSServiceAreaTaskTypes.h>
29 
32 @class AGSQueryParameters;
33 @class AGSPointBarrier;
34 @class AGSPolygonBarrier;
35 @class AGSPolylineBarrier;
36 @class AGSSpatialReference;
37 @class AGSTravelMode;
38  //Required for Globals API doc
40 
49 @interface AGSServiceAreaParameters : AGSObject <NSCopying>
50 
51 
52 
53 #pragma mark -
54 #pragma mark initializers
55 
56 
57 
58 #pragma mark -
59 #pragma mark properties
60 
65 @property (nonatomic, copy, readwrite) NSArray<NSString*> *accumulateAttributeNames;
66 
73 @property (nonatomic, copy, readwrite) NSArray<NSNumber*> *defaultImpedanceCutoffs;
74 
78 @property (nonatomic, assign, readwrite) AGSServiceAreaPolygonCutoffGeometry geometryAtCutoff;
79 
83 @property (nonatomic, assign, readwrite) AGSServiceAreaOverlapGeometry geometryAtOverlap;
84 
89 @property (nullable, nonatomic, strong, readwrite) AGSSpatialReference *outputSpatialReference;
90 
91 
95 @property (nonatomic, assign, readwrite) double polygonBufferDistance;
96 
100 @property (nonatomic, assign, readwrite) AGSServiceAreaPolygonDetail polygonDetail;
101 
106 @property (nonatomic, assign, readwrite) BOOL returnPointBarriers;
107 
112 @property (nonatomic, assign, readwrite) BOOL returnPolygonBarriers;
113 
117 @property (nonatomic, assign, readwrite) BOOL returnPolygons;
118 
123 @property (nonatomic, assign, readwrite) BOOL returnPolylineBarriers;
124 
128 @property (nonatomic, assign, readwrite) BOOL returnPolylines;
129 
133 @property (nullable, nonatomic, strong, readwrite) NSDate *startTime;
134 
139 @property (nonatomic, assign, readwrite) AGSTravelDirection travelDirection;
140 
144 @property (nullable, nonatomic, strong, readwrite) AGSTravelMode *travelMode;
145 
146 #pragma mark -
147 #pragma mark methods
148 
152 -(void)clearFacilities;
153 
159 -(void)clearPointBarriers;
160 
166 -(void)clearPolygonBarriers;
167 
173 -(void)clearPolylineBarriers;
174 
179 -(void)setFacilities:(NSArray<AGSServiceAreaFacility*>*)facilities;
180 
186 -(void)setFacilitiesWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
187 
192 -(void)setPointBarriers:(NSArray<AGSPointBarrier*>*)pointBarriers;
193 
199 -(void)setPointBarriersWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
200 
205 -(void)setPolygonBarriers:(NSArray<AGSPolygonBarrier*>*)polygonBarriers;
206 
212 -(void)setPolygonBarriersWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
213 
218 -(void)setPolylineBarriers:(NSArray<AGSPolylineBarrier*>*)lineBarriers;
219 
225 -(void)setPolylineBarriersWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
226 
232 -(NSString *)searchWhereClauseWithSourceName:(NSString *)sourceName;
233 
241 -(void)setSearchWhereClauseWithSourceName:(NSString *)sourceName
242  searchWhereClause:(NSString *)searchWhereClause;
243 
244 
245 
246 @end
AGSTravelDirection
Definition: AGSRouteTypes.h:89
AGSServiceAreaPolygonCutoffGeometry
Definition: AGSServiceAreaTaskTypes.h:43
AGSServiceAreaPolygonDetail
Definition: AGSServiceAreaTaskTypes.h:52
AGSServiceAreaOverlapGeometry
Definition: AGSServiceAreaTaskTypes.h:33
An ArcGIS specific source for dataset containing geographic features or non-spatial records.
Definition: AGSArcGISFeatureTable.h:66
Definition: AGSObject.h:28
A point barrier to constrain routes.
Definition: AGSPointBarrier.h:43
A polygon barrier to constrain routes.
Definition: AGSPolygonBarrier.h:42
A polyline barrier to constrain routes.
Definition: AGSPolylineBarrier.h:42
Parameters to perform a query using AGSFeatureTable.
Definition: AGSQueryParameters.h:45
A facility to use in service area analysis.
Definition: AGSServiceAreaFacility.h:41
Input parameters for AGSServiceAreaTask.
Definition: AGSServiceAreaParameters.h:49
BOOL returnPolylineBarriers
Definition: AGSServiceAreaParameters.h:123
BOOL returnPolylines
Definition: AGSServiceAreaParameters.h:128
NSDate * startTime
Definition: AGSServiceAreaParameters.h:133
NSArray< NSNumber * > * defaultImpedanceCutoffs
Definition: AGSServiceAreaParameters.h:73
AGSSpatialReference * outputSpatialReference
Definition: AGSServiceAreaParameters.h:89
AGSServiceAreaOverlapGeometry geometryAtOverlap
Definition: AGSServiceAreaParameters.h:83
NSArray< NSString * > * accumulateAttributeNames
Definition: AGSServiceAreaParameters.h:65
AGSTravelMode * travelMode
Definition: AGSServiceAreaParameters.h:144
BOOL returnPolygonBarriers
Definition: AGSServiceAreaParameters.h:112
AGSServiceAreaPolygonDetail polygonDetail
Definition: AGSServiceAreaParameters.h:100
BOOL returnPointBarriers
Definition: AGSServiceAreaParameters.h:106
double polygonBufferDistance
Definition: AGSServiceAreaParameters.h:95
AGSServiceAreaPolygonCutoffGeometry geometryAtCutoff
Definition: AGSServiceAreaParameters.h:78
BOOL returnPolygons
Definition: AGSServiceAreaParameters.h:117
AGSTravelDirection travelDirection
Definition: AGSServiceAreaParameters.h:139
Represents the spatial reference of a geometry.
Definition: AGSSpatialReference.h:46
Travel options for routes generated by AGSRouteTask.
Definition: AGSTravelMode.h:54