AGSLocationDataSource.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>



typedef NS_ENUM(NSInteger, AGSLocationDataSourceStatus) {
    AGSLocationDataSourceStatusStopped = 0,         
    AGSLocationDataSourceStatusStarting = 1,        
    AGSLocationDataSourceStatusStarted = 2,         
    AGSLocationDataSourceStatusFailedToStart = 4    
};

@class AGSLocation;
@class AGSPoint;
@protocol AGSLocationChangeHandlerDelegate;

@interface AGSLocationDataSource : AGSObject

#pragma mark -
#pragma mark initializers


#pragma mark -
#pragma mark properties

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

@property (nullable, nonatomic, strong, readonly) NSError *error;

@property (nullable, nonatomic, weak, readwrite) id<AGSLocationChangeHandlerDelegate> locationChangeHandlerDelegate;

#pragma mark -
#pragma mark methods

-(void)startWithCompletion:(nullable void(^)(NSError *__nullable error))completion;

-(void)stop;

@end

@interface AGSLocationDataSource (ForSubclassEyesOnly)

-(void)doStart;

-(void)doStop;

-(void)didStartOrFailWithError:(nullable NSError*)error;

-(void)didStop;

-(void)didUpdateHeading:(double)heading;

-(void)didUpdateLocation:(AGSLocation*)location;

@end

#pragma mark -
#pragma mark Location Change Handler Delegate Methods
#pragma mark -

@protocol AGSLocationChangeHandlerDelegate 
@optional

- (void)locationDataSource:(AGSLocationDataSource *)locationDataSource locationDidChange:(AGSLocation *)location;

- (void)locationDataSource:(AGSLocationDataSource *)locationDataSource headingDidChange:(double)heading;

- (void)locationDataSource:(AGSLocationDataSource *)locationDataSource statusDidChange:(AGSLocationDataSourceStatus)status;

@end