ArcGIS Runtime SDK for iOS: AGSRouteParameters.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSRouteParameters.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 
30 @class AGSSpatialReference;
31 @class AGSTravelMode;
33 @class AGSQueryParameters;
34 @class AGSPointBarrier;
35 @class AGSPolylineBarrier;
36 @class AGSPolygonBarrier;
37 @class AGSStop;
38  //Required for Globals API doc
40 
49 @interface AGSRouteParameters : AGSObject <NSCopying>
50 
51 
52 #pragma mark -
53 #pragma mark initializers
54 
55 -(instancetype)init;
56 +(instancetype)routeParameters;
57 
58 #pragma mark -
59 #pragma mark properties
60 
64 @property (nonatomic, copy, readwrite) NSArray<NSString*> *accumulateAttributeNames;
65 
69 @property (nonatomic, assign, readwrite) AGSUnitSystem directionsDistanceUnits;
70 
74 @property (nonatomic, copy, readwrite) NSString *directionsLanguage;
75 
79 @property (nonatomic, assign, readwrite) AGSDirectionsStyle directionsStyle;
80 
86 @property (nonatomic, assign, readwrite) BOOL findBestSequence;
87 
91 @property (nullable, nonatomic, strong, readwrite) NSDate *startTime;
92 
97 @property (nullable, nonatomic, strong, readwrite) AGSSpatialReference *outputSpatialReference;
98 
103 @property (nonatomic, assign, readwrite) BOOL preserveFirstStop;
104 
109 @property (nonatomic, assign, readwrite) BOOL preserveLastStop;
110 
114 @property (nonatomic, assign, readwrite) BOOL returnDirections;
115 
119 @property (nonatomic, assign, readwrite) BOOL returnPointBarriers;
120 
124 @property (nonatomic, assign, readwrite) BOOL returnPolygonBarriers;
125 
129 @property (nonatomic, assign, readwrite) BOOL returnPolylineBarriers;
130 
134 @property (nonatomic, assign, readwrite) BOOL returnRoutes;
135 
139 @property (nonatomic, assign, readwrite) BOOL returnStops;
140 
144 @property (nonatomic, assign, readwrite) AGSRouteShapeType routeShapeType;
145 
149 @property (nullable, nonatomic, strong, readwrite) AGSTravelMode *travelMode;
150 
151 #pragma mark -
152 #pragma mark methods
153 
157 -(void)clearPointBarriers;
158 
162 -(void)clearPolygonBarriers;
163 
167 -(void)clearPolylineBarriers;
168 
172 -(void)clearStops;
173 
178 -(void)setPointBarriers:(NSArray<AGSPointBarrier*>*)pointBarriers;
179 
185 -(void)setPointBarriersWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
186 
191 -(void)setPolygonBarriers:(NSArray<AGSPolygonBarrier*>*)polygonBarriers;
192 
198 -(void)setPolygonBarriersWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
199 
204 -(void)setPolylineBarriers:(NSArray<AGSPolylineBarrier*>*)lineBarriers;
205 
211 -(void)setPolylineBarriersWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
212 
217 -(void)setStops:(NSArray<AGSStop*>*)stops;
218 
224 -(void)setStopsWithFeatureTable:(AGSArcGISFeatureTable*)featureTable queryParameters:(AGSQueryParameters*)queryParameters;
225 
231 -(NSString*)searchWhereClauseForSourceName:(NSString*)sourceName;
232 
238 -(void)setSearchWhereClause:(NSString*)searchWhereClause forSourceName:(NSString*)sourceName;
239 
240 
241 @end
AGSRouteShapeType
Definition: AGSRouteTypes.h:79
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
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
Input parameters for AGSRouteTask.
Definition: AGSRouteParameters.h:49
BOOL returnPointBarriers
Definition: AGSRouteParameters.h:119
BOOL preserveLastStop
Definition: AGSRouteParameters.h:109
BOOL returnRoutes
Definition: AGSRouteParameters.h:134
NSDate * startTime
Definition: AGSRouteParameters.h:91
BOOL preserveFirstStop
Definition: AGSRouteParameters.h:103
BOOL returnPolylineBarriers
Definition: AGSRouteParameters.h:129
BOOL findBestSequence
Definition: AGSRouteParameters.h:86
AGSTravelMode * travelMode
Definition: AGSRouteParameters.h:149
instancetype init()
AGSRouteShapeType routeShapeType
Definition: AGSRouteParameters.h:144
AGSSpatialReference * outputSpatialReference
Definition: AGSRouteParameters.h:97
NSArray< NSString * > * accumulateAttributeNames
Definition: AGSRouteParameters.h:64
BOOL returnStops
Definition: AGSRouteParameters.h:139
BOOL returnPolygonBarriers
Definition: AGSRouteParameters.h:124
NSString * directionsLanguage
Definition: AGSRouteParameters.h:74
BOOL returnDirections
Definition: AGSRouteParameters.h:114
AGSDirectionsStyle directionsStyle
Definition: AGSRouteParameters.h:79
instancetype routeParameters()
AGSUnitSystem directionsDistanceUnits
Definition: AGSRouteParameters.h:69
Represents the spatial reference of a geometry.
Definition: AGSSpatialReference.h:46
A class that represents a location to be visited along a route.
Definition: AGSStop.h:59
Travel options for routes generated by AGSRouteTask.
Definition: AGSTravelMode.h:54