ArcGIS Runtime SDK for iOS: AGSClosestFacilityParameters.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSClosestFacilityParameters.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/AGSUnitSystem.h>
28 #import <ArcGIS/AGSRouteTypes.h>
29 #import <ArcGIS/AGSClosestFacilityTaskTypes.h>
30 
32 @class AGSQueryParameters;
33 @class AGSPointBarrier;
34 @class AGSPolylineBarrier;
35 @class AGSPolygonBarrier;
36 @class AGSTravelMode;
37 @class AGSFacility;
38 @class AGSIncident;
39 @class AGSSpatialReference;
40  //Required for Globals API doc
42 
52 
53 
54 #pragma mark -
55 #pragma mark initializers
56 
57 
58 
59 #pragma mark -
60 #pragma mark properties
61 
65 @property (nonatomic, copy, readwrite) NSArray<NSString*> *accumulateAttributeNames;
66 
72 @property (nonatomic, assign, readwrite) double defaultImpedanceCutoff;
73 
78 @property (nonatomic, assign, readwrite) NSInteger defaultTargetFacilityCount;
79 
83 @property (nonatomic, assign, readwrite) AGSUnitSystem directionsDistanceUnits;
84 
88 @property (nonatomic, copy, readwrite) NSString *directionsLanguage;
89 
93 @property (nonatomic, assign, readwrite) AGSDirectionsStyle directionsStyle;
94 
99 @property (nullable, nonatomic, strong, readwrite) AGSSpatialReference *outputSpatialReference;
100 
104 @property (nonatomic, assign, readwrite) BOOL returnDirections;
105 
110 @property (nonatomic, assign, readwrite) BOOL returnPointBarriers;
111 
116 @property (nonatomic, assign, readwrite) BOOL returnPolygonBarriers;
117 
122 @property (nonatomic, assign, readwrite) BOOL returnPolylineBarriers;
123 
127 @property (nonatomic, assign, readwrite) BOOL returnRoutes;
128 
132 @property (nonatomic, assign, readwrite) AGSRouteShapeType routeShapeType;
133 
138 @property (nullable, nonatomic, strong, readwrite) NSDate *startTime;
139 
143 @property (nonatomic, assign, readwrite) AGSStartTimeUsage startTimeUsage;
144 
149 @property (nonatomic, assign, readwrite) AGSTravelDirection travelDirection;
150 
154 @property (nullable, nonatomic, strong, readwrite) AGSTravelMode *travelMode;
155 
156 #pragma mark -
157 #pragma mark methods
158 
164 -(void)clearFacilities;
165 
171 -(void)clearIncidents;
172 
178 -(void)clearPointBarriers;
179 
185 -(void)clearPolygonBarriers;
186 
192 -(void)clearPolylineBarriers;
193 
199 -(NSString*)searchWhereClauseForSourceName:(NSString*)sourceName;
200 
201 
207 -(void)setSearchWhereClause:(NSString*)searchWhereClause forSourceName:(NSString*)sourceName;
208 
213 -(void)setFacilities:(NSArray<AGSFacility*>*)facilities;
214 
220 -(void)setFacilitiesWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
221 
226 -(void)setIncidents:(NSArray<AGSIncident*>*)incidents;
227 
233 -(void)setIncidentsWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
234 
239 -(void)setPointBarriers:(NSArray<AGSPointBarrier*>*)pointBarriers;
240 
246 -(void)setPointBarriersWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
247 
248 
253 -(void)setPolygonBarriers:(NSArray<AGSPolygonBarrier*>*)polygonBarriers;
254 
260 -(void)setPolygonBarriersWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
261 
262 
267 -(void)setPolylineBarriers:(NSArray<AGSPolylineBarrier*>*)lineBarriers;
268 
274 -(void)setPolylineBarriersWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
275 
276 
277 @end
AGSStartTimeUsage
Definition: AGSClosestFacilityTaskTypes.h:35
AGSRouteShapeType
Definition: AGSRouteTypes.h:79
AGSTravelDirection
Definition: AGSRouteTypes.h:89
AGSDirectionsStyle
Definition: AGSRouteTypes.h:47
AGSUnitSystem
Definition: AGSUnitSystem.h:35
An ArcGIS specific source for dataset containing geographic features or non-spatial records.
Definition: AGSArcGISFeatureTable.h:66
Input parameters for AGSClosestFacilityTask.
Definition: AGSClosestFacilityParameters.h:52
BOOL returnRoutes
Definition: AGSClosestFacilityParameters.h:127
AGSStartTimeUsage startTimeUsage
Definition: AGSClosestFacilityParameters.h:143
NSDate * startTime
Definition: AGSClosestFacilityParameters.h:138
AGSUnitSystem directionsDistanceUnits
Definition: AGSClosestFacilityParameters.h:83
BOOL returnPointBarriers
Definition: AGSClosestFacilityParameters.h:110
NSInteger defaultTargetFacilityCount
Definition: AGSClosestFacilityParameters.h:78
BOOL returnPolygonBarriers
Definition: AGSClosestFacilityParameters.h:116
NSString * directionsLanguage
Definition: AGSClosestFacilityParameters.h:88
AGSTravelMode * travelMode
Definition: AGSClosestFacilityParameters.h:154
AGSRouteShapeType routeShapeType
Definition: AGSClosestFacilityParameters.h:132
BOOL returnPolylineBarriers
Definition: AGSClosestFacilityParameters.h:122
AGSDirectionsStyle directionsStyle
Definition: AGSClosestFacilityParameters.h:93
AGSTravelDirection travelDirection
Definition: AGSClosestFacilityParameters.h:149
NSArray< NSString * > * accumulateAttributeNames
Definition: AGSClosestFacilityParameters.h:65
BOOL returnDirections
Definition: AGSClosestFacilityParameters.h:104
double defaultImpedanceCutoff
Definition: AGSClosestFacilityParameters.h:72
AGSSpatialReference * outputSpatialReference
Definition: AGSClosestFacilityParameters.h:99
A facility to use in closest facility or service area analysis.
Definition: AGSFacility.h:41
An incident to use in closest facility analysis.
Definition: AGSIncident.h:41
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
Represents the spatial reference of a geometry.
Definition: AGSSpatialReference.h:46
Travel options for routes generated by AGSRouteTask.
Definition: AGSTravelMode.h:54