NMPositionOnRoute Class Reference

Inherits <NSObject>.

Instance Methods
(nullable instancetype)	- NS_UNAVAILABLE
(nullable instancetype)	- initWithDistanceToDestination:timeToDestination:passedDistance:

Class Methods
(nullable instancetype)	+ NS_UNAVAILABLE

Properties
NSInteger	distanceToDestinationInMeters
NSInteger	timeToDestinationInSeconds
NSInteger	passedDistanceInMeters

Detailed Description

Interface representing altering route position information.

Method Documentation

initWithDistanceToDestination:timeToDestination:passedDistance:()

- (nullable instancetype) initWithDistanceToDestination:		(NSInteger)	distanceToDestinationInMeters
timeToDestination:		(NSInteger)	timeToDestinationInSeconds
passedDistance:		(NSInteger)	passedDistanceInMeters

Initializes object with the specified parameters.

Parameters

distanceToDestinationInMeters	Distance from the current position on route to destination in meters;
timeToDestinationInSeconds	Estimated travel time from the current position on route to destination in seconds;
passedDistanceInMeters	Distance from the route origin to the current position on route in meters.

NS_UNAVAILABLE() [1/2]

- (nullable instancetype) NS_UNAVAILABLE

Default initialization is forbidden.

NS_UNAVAILABLE() [2/2]

+ (nullable instancetype) NS_UNAVAILABLE

Property Documentation

distanceToDestinationInMeters

- (NSInteger) distanceToDestinationInMeters

readnonatomicassign

Returns distance to destination from the current position on route in meters. Returns -1 if object is in uninitialized state.

passedDistanceInMeters

- (NSInteger) passedDistanceInMeters

readnonatomicassign

Returns distance from the route origin to the current position on route in meters. Returns -1 if object is in uninitialized state.

timeToDestinationInSeconds

- (NSInteger) timeToDestinationInSeconds

readnonatomicassign

Returns time to destination from the current position in seconds. Returns -1 if object is in uninitialized state.