AGSTrackingStatus Class Reference

Description

Defines route tracking current status data.

Contains information about route tracker status.

See also

- routeTracker:didUpdateTrackingStatus: (AGSRouteTrackerDelegate-p)

Since

100.6

Inheritance diagram for AGSTrackingStatus:

Properties
BOOL	approachingFinalDestination
NSInteger	currentManeuverIndex
AGSTrackingProgress *	destinationProgress
AGSDestinationStatus	destinationStatus
AGSLocation *	displayLocation
AGSLocation *	locationOnRoute
AGSTrackingProgress *	maneuverProgress
BOOL	onRoute
NSInteger	remainingDestinationCount
BOOL	routeCalculating
AGSTrackingProgress *	routeProgress
AGSRouteResult *	routeResult
NSArray< NSNumber * > *	stopIndexesAtNextDestination

Property Documentation

approachingFinalDestination

- (BOOL) approachingFinalDestination

readnonatomicassign

YES if the next AGSStop (or stops) are the final destination in the route. If there are coincident stops at the end, the AGSRouteTracker::skipCoincidentStops value determines if they are treated as single destination or not.

Since

100.9

currentManeuverIndex

- (NSInteger) currentManeuverIndex

readnonatomicassign

The current maneuver index. The index of current maneuver in AGSRoute::directionManeuvers.

Since

100.6

destinationProgress

- (AGSTrackingProgress*) destinationProgress

readnonatomicstrong

The tracking progress until next destination (AGSStop).

See also

AGSTrackingProgress

Since

100.6

destinationStatus

- (AGSDestinationStatus) destinationStatus

readnonatomicassign

The destination status.

See also

AGSDestinationStatus

Since

100.6

displayLocation

- (AGSLocation*) displayLocation

readnonatomicstrong

The display location. If current location #isOnRoute is YES then this will be an adjusted location (snapped to route) and bearing (smoothed). If current location #isOnRoute is NO then this will be the passed in GPS location, but with an adjusted bearing (smoothed). This location should be used for displaying current position on a map.

See also

AGSLocation

Since

100.6

locationOnRoute

- (AGSLocation*) locationOnRoute

readnonatomicstrong

The location on route. Snapped to route location of last GPS location passed in to trackLocation:completion: (AGSRouteTracker). If current status is #isOnRoute is YES this will be the same as the AGSTrackingStatus::displayLocation. If current status is #isOnRoute is NO this value is not updated and last location that was on the route will be returned.

See also

AGSLocation

Since

100.6

maneuverProgress

- (AGSTrackingProgress*) maneuverProgress

readnonatomicstrong

The tracking progress along current maneuver.

See also

AGSTrackingProgress

Since

100.6

onRoute

- (BOOL) onRoute

readnonatomicassign

A Boolean value indicating whether the current location is on the route.

Since

100.6

remainingDestinationCount

- (NSInteger) remainingDestinationCount

readnonatomicassign

The remaining destination count. The number of (routed) stops yet to be visited. This value does not include waypoints, unlocated/unrouted locations. Calling switchToNextDestinationWithCompletion: (AGSRouteTracker) will decrease value. The invalid value for remaining destination count is -1.

See also

- switchToNextDestinationWithCompletion: (AGSRouteTracker)

Since

100.6

routeCalculating

- (BOOL) routeCalculating

readnonatomicassign

A Boolean value indicating whether the route is currently being calculated. For notification about route calculating implement routeTrackerRerouteDidStart: (AGSRouteTrackerDelegate-p).

See also

- routeTrackerRerouteDidStart: (AGSRouteTrackerDelegate-p), AGSRouteTrackerDelegate:routeTracker:rerouteDidCompleteWithTrackingStatus:error:

Since

100.6

routeProgress

- (AGSTrackingProgress*) routeProgress

readnonatomicstrong

The tracking progress along entire route.

See also

AGSTrackingProgress

Since

100.6

routeResult

- (AGSRouteResult*) routeResult

readnonatomicstrong

The route result presently being used by route tracker. If rerouting happened during tracking, this AGSRouteResult can be different than the AGSRouteResult originally set in the AGSRouteTracker. For being notified when the routeResult is updated via callback, implement AGSRouteTrackerDelegate:routeTracker:rerouteDidCompleteWithTrackingStatus:error:.

See also

- routeTrackerRerouteDidStart: (AGSRouteTrackerDelegate-p), AGSRouteTrackerDelegate:routeTracker:rerouteDidCompleteWithTrackingStatus:error:

Since

100.6

stopIndexesAtNextDestination

- (NSArray<NSNumber *>*) stopIndexesAtNextDestination

readnonatomiccopy

The AGSRoute::stops index values relating to the upcoming destination/arrival. If there are coincident stops and the value of AGSRouteTracker::skipCoincidentStops is YES, then this is an NSArray with multiple index values. When there are no coincident stops or the value of AGSRouteTracker::skipCoincidentStops is NO, then this is an NSArray with just a single index value. The array can be used to relate a destination/arrival to the stops in the AGSRoute::stops array.

Since

100.9