ArcGIS Runtime SDK for iOS: AGSTrackingStatus.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSTrackingStatus.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 
30 
31 
37 typedef NS_ENUM(NSInteger, AGSDestinationStatus) {
41 };
42 
43 @class AGSLocation;
44 @class AGSRouteResult;
45 @class AGSTrackingProgress;
46 
54 
55 #pragma mark -
56 #pragma mark initializers
57 
58 
59 
60 #pragma mark -
61 #pragma mark properties
62 
67 @property (nonatomic, assign, readonly) BOOL approachingFinalDestination;
68 
73 @property (nonatomic, assign, readonly) NSInteger currentManeuverIndex;
74 
79 @property (nonatomic, strong, readonly) AGSTrackingProgress *destinationProgress;
80 
85 @property (nonatomic, assign, readonly) AGSDestinationStatus destinationStatus;
86 
94 @property (nonatomic, strong, readonly) AGSLocation *displayLocation;
95 
104 @property (nonatomic, strong, readonly) AGSLocation *locationOnRoute;
105 
110 @property (nonatomic, strong, readonly) AGSTrackingProgress *maneuverProgress;
111 
115 @property (nonatomic, assign, readonly, getter=isOnRoute) BOOL onRoute;
116 
125 @property (nonatomic, assign, readonly) NSInteger remainingDestinationCount;
126 
132 @property (nonatomic, assign, readonly, getter=isRouteCalculating) BOOL routeCalculating;
133 
138 @property (nonatomic, strong, readonly) AGSTrackingProgress *routeProgress;
139 
147 @property (nonatomic, strong, readonly) AGSRouteResult *routeResult;
148 
156 @property (nonatomic, copy, readonly) NSArray<NSNumber *> *stopIndexesAtNextDestination;
157 
158 #pragma mark -
159 #pragma mark methods
160 
161 @end
162 
163 
AGSDestinationStatus
Definition: AGSTrackingStatus.h:37
@ AGSDestinationStatusApproaching
Definition: AGSTrackingStatus.h:39
@ AGSDestinationStatusReached
Definition: AGSTrackingStatus.h:40
@ AGSDestinationStatusNotReached
Definition: AGSTrackingStatus.h:38
Represents a location update provided by a location datasource.
Definition: AGSLocation.h:73
Definition: AGSObject.h:28
Result returned by AGSRouteTask.
Definition: AGSRouteResult.h:43
Defines tracking progress (passed and remaining geometries, remaining time and distance).
Definition: AGSTrackingProgress.h:40
Defines route tracking current status data.
Definition: AGSTrackingStatus.h:54
NSInteger currentManeuverIndex
Definition: AGSTrackingStatus.h:73
BOOL routeCalculating
Definition: AGSTrackingStatus.h:132
AGSLocation * locationOnRoute
Definition: AGSTrackingStatus.h:104
AGSTrackingProgress * destinationProgress
Definition: AGSTrackingStatus.h:79
AGSTrackingProgress * maneuverProgress
Definition: AGSTrackingStatus.h:110
NSInteger remainingDestinationCount
Definition: AGSTrackingStatus.h:125
AGSLocation * displayLocation
Definition: AGSTrackingStatus.h:94
AGSDestinationStatus destinationStatus
Definition: AGSTrackingStatus.h:85
AGSTrackingProgress * routeProgress
Definition: AGSTrackingStatus.h:138
AGSRouteResult * routeResult
Definition: AGSTrackingStatus.h:147
NSArray< NSNumber * > * stopIndexesAtNextDestination
Definition: AGSTrackingStatus.h:156
BOOL onRoute
Definition: AGSTrackingStatus.h:115
BOOL approachingFinalDestination
Definition: AGSTrackingStatus.h:67