ArcGIS Runtime SDK for iOS: AGSRoute.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSRoute.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 
28 @class AGSPolyline;
30 @class AGSStop;
31  //Required for Globals API doc
33 
40 @interface AGSRoute : AGSObject
41 
42 
43 #pragma mark -
44 #pragma mark initializers
45 
46 
47 
48 #pragma mark -
49 #pragma mark properties
50 
56 @property (nonatomic, copy, readonly) NSArray<AGSDirectionManeuver*> *directionManeuvers;
57 
61 @property (nullable, nonatomic, strong, readonly) NSDate *startTime;
62 
66 @property (nonatomic, assign, readonly) double startTimeShift;
67 
71 @property (nullable, nonatomic, strong, readonly) NSDate *endTime;
72 
76 @property (nonatomic, assign, readonly) double endTimeShift;
77 
81 @property (nonatomic, assign, readonly) double totalLength;
82 
86 @property (nullable, nonatomic, strong, readonly) AGSPolyline *routeGeometry;
87 
92 @property (nonatomic, copy, readonly) NSString *routeName;
93 
100 @property (nonatomic, copy, readonly) NSArray<AGSStop*> *stops;
101 
106 @property (nonatomic, assign, readonly) double totalTime;
107 
111 @property (nonatomic, assign, readonly) double travelTime;
112 
118 @property (nonatomic, assign, readonly) double violationTime;
119 
125 @property (nonatomic, assign, readonly) double waitTime;
126 
127 #pragma mark -
128 #pragma mark methods
129 
130 -(double)costForCostAttribute:(NSString*)attributeName;
131 
132 
133 @end
A single maneuver in a series of driving direction.
Definition: AGSDirectionManeuver.h:82
Definition: AGSObject.h:28
A multipart linear shape.
Definition: AGSPolyline.h:68
An individual route between stops.
Definition: AGSRoute.h:41
NSDate * startTime
Definition: AGSRoute.h:61
NSDate * endTime
Definition: AGSRoute.h:71
double startTimeShift
Definition: AGSRoute.h:66
double totalTime
Definition: AGSRoute.h:106
double travelTime
Definition: AGSRoute.h:111
NSArray< AGSStop * > * stops
Definition: AGSRoute.h:100
NSString * routeName
Definition: AGSRoute.h:92
double totalLength
Definition: AGSRoute.h:81
NSArray< AGSDirectionManeuver * > * directionManeuvers
Definition: AGSRoute.h:56
double waitTime
Definition: AGSRoute.h:125
AGSPolyline * routeGeometry
Definition: AGSRoute.h:86
double endTimeShift
Definition: AGSRoute.h:76
double violationTime
Definition: AGSRoute.h:118
A class that represents a location to be visited along a route.
Definition: AGSStop.h:59