ArcGIS Runtime SDK for iOS: AGSServiceAreaParameters.h Source File
ArcGIS Runtime SDK for iOS  100.9
AGSServiceAreaParameters.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 1995-2020 ESRI
3 
4  TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
5  Unpublished material - all rights reserved under the
6  Copyright Laws of the United States and applicable international
7  laws, treaties, and conventions.
8 
9  For additional information, contact:
10  Environmental Systems Research Institute, Inc.
11  Attn: Contracts and Legal Services Department
12  380 New York Street
13  Redlands, California, 92373
14  USA
15 
16  email: contracts@esri.com
17  */
18 
19 #import <ArcGIS/AGSObject.h>
20 #import <ArcGIS/AGSRouteTypes.h>
21 #import <ArcGIS/AGSServiceAreaTaskTypes.h>
22 
25 @class AGSQueryParameters;
26 @class AGSPointBarrier;
27 @class AGSPolygonBarrier;
28 @class AGSPolylineBarrier;
29 @class AGSSpatialReference;
30 @class AGSTravelMode;
31  //Required for Globals API doc
33 
42 @interface AGSServiceAreaParameters : AGSObject <NSCopying>
43 
44 
45 
46 #pragma mark -
47 #pragma mark initializers
48 
49 
50 
51 #pragma mark -
52 #pragma mark properties
53 
58 @property (nonatomic, copy, readwrite) NSArray<NSString*> *accumulateAttributeNames;
59 
66 @property (nonatomic, copy, readwrite) NSArray<NSNumber*> *defaultImpedanceCutoffs;
67 
71 @property (nonatomic, assign, readwrite) AGSServiceAreaPolygonCutoffGeometry geometryAtCutoff;
72 
76 @property (nonatomic, assign, readwrite) AGSServiceAreaOverlapGeometry geometryAtOverlap;
77 
82 @property (nullable, nonatomic, strong, readwrite) AGSSpatialReference *outputSpatialReference;
83 
84 
88 @property (nonatomic, assign, readwrite) double polygonBufferDistance;
89 
93 @property (nonatomic, assign, readwrite) AGSServiceAreaPolygonDetail polygonDetail;
94 
99 @property (nonatomic, assign, readwrite) BOOL returnPointBarriers;
100 
105 @property (nonatomic, assign, readwrite) BOOL returnPolygonBarriers;
106 
110 @property (nonatomic, assign, readwrite) BOOL returnPolygons;
111 
116 @property (nonatomic, assign, readwrite) BOOL returnPolylineBarriers;
117 
121 @property (nonatomic, assign, readwrite) BOOL returnPolylines;
122 
126 @property (nullable, nonatomic, strong, readwrite) NSDate *startTime;
127 
132 @property (nonatomic, assign, readwrite) AGSTravelDirection travelDirection;
133 
137 @property (nullable, nonatomic, strong, readwrite) AGSTravelMode *travelMode;
138 
139 #pragma mark -
140 #pragma mark methods
141 
145 -(void)clearFacilities;
146 
152 -(void)clearPointBarriers;
153 
159 -(void)clearPolygonBarriers;
160 
166 -(void)clearPolylineBarriers;
167 
172 -(void)setFacilities:(NSArray<AGSServiceAreaFacility*>*)facilities;
173 
179 -(void)setFacilitiesWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
180 
185 -(void)setPointBarriers:(NSArray<AGSPointBarrier*>*)pointBarriers;
186 
192 -(void)setPointBarriersWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
193 
198 -(void)setPolygonBarriers:(NSArray<AGSPolygonBarrier*>*)polygonBarriers;
199 
205 -(void)setPolygonBarriersWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
206 
211 -(void)setPolylineBarriers:(NSArray<AGSPolylineBarrier*>*)lineBarriers;
212 
218 -(void)setPolylineBarriersWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
219 
225 -(NSString *)searchWhereClauseWithSourceName:(NSString *)sourceName;
226 
234 -(void)setSearchWhereClauseWithSourceName:(NSString *)sourceName
235  searchWhereClause:(NSString *)searchWhereClause;
236 
237 
238 
239 @end
AGSServiceAreaPolygonDetail
Definition: AGSServiceAreaTaskTypes.h:44
A polyline barrier to constrain routes.
Definition: AGSPolylineBarrier.h:35
BOOL returnPolygons
Definition: AGSServiceAreaParameters.h:110
NSArray< NSNumber * > * defaultImpedanceCutoffs
Definition: AGSServiceAreaParameters.h:66
AGSTravelDirection
Definition: AGSRouteTypes.h:83
double polygonBufferDistance
Definition: AGSServiceAreaParameters.h:88
Parameters to perform a query using AGSFeatureTable.
Definition: AGSQueryParameters.h:37
Represents the spatial reference of a geometry.
Definition: AGSSpatialReference.h:39
BOOL returnPolygonBarriers
Definition: AGSServiceAreaParameters.h:105
A point barrier to constrain routes.
Definition: AGSPointBarrier.h:36
NSDate * startTime
Definition: AGSServiceAreaParameters.h:126
AGSServiceAreaPolygonCutoffGeometry
Definition: AGSServiceAreaTaskTypes.h:35
AGSServiceAreaOverlapGeometry geometryAtOverlap
Definition: AGSServiceAreaParameters.h:76
BOOL returnPolylines
Definition: AGSServiceAreaParameters.h:121
Definition: AGSObject.h:21
An ArcGIS specific source for dataset containing geographic features or non-spatial records...
Definition: AGSArcGISFeatureTable.h:56
NSArray< NSString * > * accumulateAttributeNames
Definition: AGSServiceAreaParameters.h:58
AGSServiceAreaOverlapGeometry
Definition: AGSServiceAreaTaskTypes.h:25
AGSServiceAreaPolygonDetail polygonDetail
Definition: AGSServiceAreaParameters.h:93
A facility to use in service area analysis.
Definition: AGSServiceAreaFacility.h:34
Input parameters for AGSServiceAreaTask.
Definition: AGSServiceAreaParameters.h:42
AGSServiceAreaPolygonCutoffGeometry geometryAtCutoff
Definition: AGSServiceAreaParameters.h:71
Travel options for routes generated by AGSRouteTask.
Definition: AGSTravelMode.h:46
AGSSpatialReference * outputSpatialReference
Definition: AGSServiceAreaParameters.h:82
BOOL returnPolylineBarriers
Definition: AGSServiceAreaParameters.h:116
AGSTravelDirection travelDirection
Definition: AGSServiceAreaParameters.h:132
AGSTravelMode * travelMode
Definition: AGSServiceAreaParameters.h:137
BOOL returnPointBarriers
Definition: AGSServiceAreaParameters.h:99
A polygon barrier to constrain routes.
Definition: AGSPolygonBarrier.h:35