ArcGIS Runtime SDK for iOS: AGSClosestFacilityParameters.h Source File
ArcGIS Runtime SDK for iOS  100.9
AGSClosestFacilityParameters.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/AGSUnitSystem.h>
21 #import <ArcGIS/AGSRouteTypes.h>
22 #import <ArcGIS/AGSClosestFacilityTaskTypes.h>
23 
25 @class AGSQueryParameters;
26 @class AGSPointBarrier;
27 @class AGSPolylineBarrier;
28 @class AGSPolygonBarrier;
29 @class AGSTravelMode;
30 @class AGSFacility;
31 @class AGSIncident;
32 @class AGSSpatialReference;
33  //Required for Globals API doc
35 
45 
46 
47 #pragma mark -
48 #pragma mark initializers
49 
50 
51 
52 #pragma mark -
53 #pragma mark properties
54 
58 @property (nonatomic, copy, readwrite) NSArray<NSString*> *accumulateAttributeNames;
59 
65 @property (nonatomic, assign, readwrite) double defaultImpedanceCutoff;
66 
71 @property (nonatomic, assign, readwrite) NSInteger defaultTargetFacilityCount;
72 
76 @property (nonatomic, assign, readwrite) AGSUnitSystem directionsDistanceUnits;
77 
81 @property (nonatomic, copy, readwrite) NSString *directionsLanguage;
82 
86 @property (nonatomic, assign, readwrite) AGSDirectionsStyle directionsStyle;
87 
92 @property (nullable, nonatomic, strong, readwrite) AGSSpatialReference *outputSpatialReference;
93 
97 @property (nonatomic, assign, readwrite) BOOL returnDirections;
98 
103 @property (nonatomic, assign, readwrite) BOOL returnPointBarriers;
104 
109 @property (nonatomic, assign, readwrite) BOOL returnPolygonBarriers;
110 
115 @property (nonatomic, assign, readwrite) BOOL returnPolylineBarriers;
116 
120 @property (nonatomic, assign, readwrite) BOOL returnRoutes;
121 
125 @property (nonatomic, assign, readwrite) AGSRouteShapeType routeShapeType;
126 
131 @property (nullable, nonatomic, strong, readwrite) NSDate *startTime;
132 
136 @property (nonatomic, assign, readwrite) AGSStartTimeUsage startTimeUsage;
137 
142 @property (nonatomic, assign, readwrite) AGSTravelDirection travelDirection;
143 
147 @property (nullable, nonatomic, strong, readwrite) AGSTravelMode *travelMode;
148 
149 #pragma mark -
150 #pragma mark methods
151 
157 -(void)clearFacilities;
158 
164 -(void)clearIncidents;
165 
171 -(void)clearPointBarriers;
172 
178 -(void)clearPolygonBarriers;
179 
185 -(void)clearPolylineBarriers;
186 
192 -(NSString*)searchWhereClauseForSourceName:(NSString*)sourceName;
193 
194 
200 -(void)setSearchWhereClause:(NSString*)searchWhereClause forSourceName:(NSString*)sourceName;
201 
206 -(void)setFacilities:(NSArray<AGSFacility*>*)facilities;
207 
213 -(void)setFacilitiesWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
214 
219 -(void)setIncidents:(NSArray<AGSIncident*>*)incidents;
220 
226 -(void)setIncidentsWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
227 
232 -(void)setPointBarriers:(NSArray<AGSPointBarrier*>*)pointBarriers;
233 
239 -(void)setPointBarriersWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
240 
241 
246 -(void)setPolygonBarriers:(NSArray<AGSPolygonBarrier*>*)polygonBarriers;
247 
253 -(void)setPolygonBarriersWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
254 
255 
260 -(void)setPolylineBarriers:(NSArray<AGSPolylineBarrier*>*)lineBarriers;
261 
267 -(void)setPolylineBarriersWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
268 
269 
270 @end
NSInteger defaultTargetFacilityCount
Definition: AGSClosestFacilityParameters.h:71
NSDate * startTime
Definition: AGSClosestFacilityParameters.h:131
AGSTravelMode * travelMode
Definition: AGSClosestFacilityParameters.h:147
A polyline barrier to constrain routes.
Definition: AGSPolylineBarrier.h:35
AGSTravelDirection
Definition: AGSRouteTypes.h:83
BOOL returnPolylineBarriers
Definition: AGSClosestFacilityParameters.h:115
AGSStartTimeUsage startTimeUsage
Definition: AGSClosestFacilityParameters.h:136
Parameters to perform a query using AGSFeatureTable.
Definition: AGSQueryParameters.h:37
AGSDirectionsStyle
Definition: AGSRouteTypes.h:41
AGSTravelDirection travelDirection
Definition: AGSClosestFacilityParameters.h:142
Represents the spatial reference of a geometry.
Definition: AGSSpatialReference.h:39
NSArray< NSString * > * accumulateAttributeNames
Definition: AGSClosestFacilityParameters.h:58
BOOL returnRoutes
Definition: AGSClosestFacilityParameters.h:120
BOOL returnPointBarriers
Definition: AGSClosestFacilityParameters.h:103
A facility to use in closest facility or service area analysis.
Definition: AGSFacility.h:34
A point barrier to constrain routes.
Definition: AGSPointBarrier.h:36
double defaultImpedanceCutoff
Definition: AGSClosestFacilityParameters.h:65
AGSUnitSystem directionsDistanceUnits
Definition: AGSClosestFacilityParameters.h:76
BOOL returnPolygonBarriers
Definition: AGSClosestFacilityParameters.h:109
AGSRouteShapeType routeShapeType
Definition: AGSClosestFacilityParameters.h:125
Definition: AGSObject.h:21
Input parameters for AGSClosestFacilityTask.
Definition: AGSClosestFacilityParameters.h:44
An ArcGIS specific source for dataset containing geographic features or non-spatial records...
Definition: AGSArcGISFeatureTable.h:56
An incident to use in closest facility analysis.
Definition: AGSIncident.h:34
Travel options for routes generated by AGSRouteTask.
Definition: AGSTravelMode.h:46
AGSRouteShapeType
Definition: AGSRouteTypes.h:73
NSString * directionsLanguage
Definition: AGSClosestFacilityParameters.h:81
AGSStartTimeUsage
Definition: AGSClosestFacilityTaskTypes.h:29
A polygon barrier to constrain routes.
Definition: AGSPolygonBarrier.h:35
AGSUnitSystem
Definition: AGSUnitSystem.h:29
AGSDirectionsStyle directionsStyle
Definition: AGSClosestFacilityParameters.h:86
AGSSpatialReference * outputSpatialReference
Definition: AGSClosestFacilityParameters.h:92
BOOL returnDirections
Definition: AGSClosestFacilityParameters.h:97