ArcGIS Runtime SDK for iOS: AGSStop.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSStop.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  //Required for Globals API doc
26 
27 #import <Foundation/Foundation.h>
28 #import <ArcGIS/AGSObject.h>
29 #import <ArcGIS/AGSRouteTypes.h>
30 
31 
32 
37 typedef NS_ENUM(NSUInteger, AGSStopType) {
41 };
42 
43 @class AGSPoint;
44 @class AGSNetworkLocation;
45 
59 @interface AGSStop : AGSObject <NSCopying>
60 
61 #pragma mark -
62 #pragma mark initializers
63 
64 
65 
71 -(instancetype)initWithPoint:(AGSPoint*)point;
72 
78 +(instancetype)stopWithPoint:(AGSPoint*)point;
79 
80 #pragma mark -
81 #pragma mark properties
82 
86 @property (nonatomic, assign, readonly) AGSCurbApproach arrivalCurbApproach;
87 
91 @property (nonatomic, assign, readonly) AGSCurbApproach departureCurbApproach;
92 
98 @property (nonatomic, assign, readwrite) AGSCurbApproach curbApproach;
99 
106 @property (nonatomic, assign, readwrite) double currentBearing;
107 
111 @property (nonatomic, assign, readwrite) double currentBearingTolerance;
112 
117 @property (nonatomic, assign, readonly) double distanceToNetworkLocation;
118 
122 @property (nullable, nonatomic, strong, readwrite) AGSPoint *geometry;
123 
127 @property (nullable, nonatomic, strong, readonly) NSDate *arrivalTime;
128 
132 @property (nonatomic, assign, readonly) double arrivalTimeShift;
133 
137 @property (nullable, nonatomic, strong, readonly) NSDate *departureTime;
138 
142 @property (nonatomic, assign, readonly) double departureTimeShift;
143 
148 @property (nullable, nonatomic, strong, readwrite) NSDate *timeWindowStart;
149 
154 @property (nullable, nonatomic, strong, readwrite) NSDate *timeWindowEnd;
155 
160 @property (nonatomic, assign, readonly) AGSLocationStatus locationStatus;
161 
165 @property (nonatomic, copy, readwrite) NSString *name;
166 
170 @property (nonatomic, assign, readwrite) AGSStopType stopType;
171 
177 @property (nonatomic, assign, readwrite) NSInteger stopID;
178 
182 @property (nonatomic, assign, readwrite) double navigationLatency;
183 
187 @property (nonatomic, assign, readwrite) double navigationSpeed;
188 
193 @property (nullable, nonatomic, strong, readwrite) AGSNetworkLocation *networkLocation;
194 
198 @property (nonatomic, copy, readwrite) NSString *routeName;
199 
204 @property (nonatomic, assign, readonly) NSInteger sequence;
205 
210 @property (nonatomic, assign, readonly) double violationTime;
211 
216 @property (nonatomic, assign, readonly) double waitTime;
217 
218 #pragma mark -
219 #pragma mark methods
220 
226 -(double)addedCostForCostAttribute:(NSString*)attributeName;
227 
234 -(void)setAddedCost:(double)addedCost forCostAttribute:(NSString*)attributeName;
235 
242 -(double)cumulativeCostForCostAttribute:(NSString*)attributeName;
243 
244 @end
245 
246 
AGSLocationStatus
Definition: AGSRouteTypes.h:57
AGSCurbApproach
Definition: AGSRouteTypes.h:35
AGSStopType
Definition: AGSStop.h:37
@ AGSStopTypeWaypoint
Definition: AGSStop.h:39
@ AGSStopTypeStop
Definition: AGSStop.h:38
@ AGSStopTypeRestBreak
Definition: AGSStop.h:40
References a specific location/position along a transportation network source feature.
Definition: AGSNetworkLocation.h:39
Definition: AGSObject.h:28
A location defined by x and y (and optionally z) coordinates.
Definition: AGSPoint.h:73
A class that represents a location to be visited along a route.
Definition: AGSStop.h:59
AGSCurbApproach departureCurbApproach
Definition: AGSStop.h:91
double waitTime
Definition: AGSStop.h:216
double arrivalTimeShift
Definition: AGSStop.h:132
NSString * name
Definition: AGSStop.h:165
double violationTime
Definition: AGSStop.h:210
AGSNetworkLocation * networkLocation
Definition: AGSStop.h:193
AGSCurbApproach curbApproach
Definition: AGSStop.h:98
AGSCurbApproach arrivalCurbApproach
Definition: AGSStop.h:86
double distanceToNetworkLocation
Definition: AGSStop.h:117
double departureTimeShift
Definition: AGSStop.h:142
NSInteger stopID
Definition: AGSStop.h:177
AGSStopType stopType
Definition: AGSStop.h:170
NSDate * departureTime
Definition: AGSStop.h:137
NSDate * arrivalTime
Definition: AGSStop.h:127
double currentBearingTolerance
Definition: AGSStop.h:111
double currentBearing
Definition: AGSStop.h:106
NSDate * timeWindowStart
Definition: AGSStop.h:148
double navigationSpeed
Definition: AGSStop.h:187
AGSLocationStatus locationStatus
Definition: AGSStop.h:160
AGSPoint * geometry
Definition: AGSStop.h:122
NSDate * timeWindowEnd
Definition: AGSStop.h:154
NSString * routeName
Definition: AGSStop.h:198
NSInteger sequence
Definition: AGSStop.h:204
double navigationLatency
Definition: AGSStop.h:182