AGSRouteTracker.h

Go to the documentation of this file.

/*
 COPYRIGHT 1995-2020 ESRI
 
 TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
 Unpublished material - all rights reserved under the
 Copyright Laws of the United States and applicable international
 laws, treaties, and conventions.
 
 For additional information, contact:
 Environmental Systems Research Institute, Inc.
 Attn: Contracts and Legal Services Department
 380 New York Street
 Redlands, California, 92373
 USA
 
 email: contracts@esri.com
 */
 //Required for Globals API doc

#import <ArcGIS/AGSObject.h>
#import <ArcGIS/AGSUnitSystem.h>



typedef NS_ENUM(NSInteger, AGSReroutingStrategy) {
    AGSReroutingStrategyToNextWaypoint = 0,       
    AGSReroutingStrategyToNextStop = 1,           
    AGSReroutingStrategyResequenceStopsOnly = 2   
};

@class AGSLocation;
@class AGSRouteParameters;
@class AGSRouteResult;
@class AGSRouteTask;
@class AGSTrackingStatus;
@class AGSVoiceGuidance;

@protocol AGSCancelable, AGSRouteTrackerDelegate;

@interface AGSRouteTracker : AGSObject

#pragma mark -
#pragma mark initializers



- (nullable instancetype)initWithRouteResult:(AGSRouteResult *)routeResult
                                  routeIndex:(NSInteger)routeIndex
                         skipCoincidentStops:(BOOL)skipCoincidentStops;

+ (nullable instancetype)routeTrackerWithRouteResult:(AGSRouteResult *)routeResult
                                          routeIndex:(NSInteger)routeIndex
                                 skipCoincidentStops:(BOOL)skipCoincidentStops;

#pragma mark -
#pragma mark properties

@property (nullable, nonatomic, weak, readwrite) id<AGSRouteTrackerDelegate> delegate;

@property (nonatomic, assign, readonly, getter=isReroutingEnabled) BOOL reroutingEnabled;

@property (nonatomic, assign, readonly) BOOL skipCoincidentStops;

@property (nullable, nonatomic, strong, readonly) AGSTrackingStatus *trackingStatus;

@property (nonatomic, assign, readwrite) AGSUnitSystem voiceGuidanceUnitSystem;

#pragma mark -
#pragma mark methods

-(void)cancelRerouting;

-(void)disableRerouting;

-(id<AGSCancelable>)enableReroutingWithRouteTask:(AGSRouteTask *)routeTask 
                                 routeParameters:(AGSRouteParameters *)routeParameters
                                        strategy:(AGSReroutingStrategy)strategy
                           visitFirstStopOnStart:(BOOL)visitFirstStopOnStart
                                      completion:(void(^)(NSError * __nullable error))completion;

-(nullable AGSVoiceGuidance *)generateVoiceGuidance;

-(id<AGSCancelable>)switchToNextDestinationWithCompletion:(nullable void(^)(NSError * __nullable error))completion;

-(id<AGSCancelable>)trackLocation:(AGSLocation *)location 
                       completion:(nullable void(^)(NSError * __nullable error))completion;

@end

@protocol AGSRouteTrackerDelegate 

@optional

-(void)routeTracker:(AGSRouteTracker*)routeTracker
didGenerateNewVoiceGuidance:(AGSVoiceGuidance*)voiceGuidance;


-(void)routeTrackerRerouteDidStart:(AGSRouteTracker*)routeTracker;


-(void)routeTracker:(AGSRouteTracker*)routeTracker
rerouteDidCompleteWithTrackingStatus:(nullable AGSTrackingStatus*)trackingStatus
              error:(nullable NSError*)error;


-(void)routeTracker:(AGSRouteTracker*)routeTracker
didUpdateTrackingStatus:(AGSTrackingStatus*)trackingStatus;

@end

@interface AGSRouteTracker (AGSDeprecated)

- (nullable instancetype)initWithRouteResult:(AGSRouteResult *)routeResult
                                  routeIndex:(NSInteger)routeIndex ;

+ (nullable instancetype)routeTrackerWithRouteResult:(AGSRouteResult *)routeResult
                                          routeIndex:(NSInteger)routeIndex ;

@end