NMRoute Class Reference

Inherits <NSObject>.

Instance Methods
(nullable instancetype)	- NS_UNAVAILABLE

Class Methods
(nullable instancetype)	+ NS_UNAVAILABLE

Properties
NSString *	name
NSUInteger	length
NSUInteger	estimatedTime
NSUInteger	estimatedTimeIgnoringTrafficDelay
NSArray< NMMapCoordinates * > *	geometry
NMMapRectangle *	boundingBox
NSArray< NMMapCoordinates * > *	routePlan

Detailed Description

A class representing a calculated route.

Method Documentation

NS_UNAVAILABLE() [1/2]

- (nullable instancetype) NS_UNAVAILABLE

Default initialization is forbidden.

NS_UNAVAILABLE() [2/2]

+ (nullable instancetype) NS_UNAVAILABLE

Property Documentation

boundingBox

- (NMMapRectangle*) boundingBox

readnonatomiccopy

Rectangle bounding the route geometry.

estimatedTime

- (NSUInteger) estimatedTime

readnonatomicassign

Estimated route time in seconds.

estimatedTimeIgnoringTrafficDelay

- (NSUInteger) estimatedTimeIgnoringTrafficDelay

readnonatomicassign

Estimated route time in seconds not considering delays caused by traffic.

Note

The property returns non-zero value only if computeEstimatedTimeIgnoringTrafficDelay property was set to 'YES' in route calculation options (NMRouteCalculationOptions).

geometry

- (NSArray<NMMapCoordinates *>*) geometry

readnonatomicstrong

The geometry of the route. The array contains ordered points of the route polyline.

length

- (NSUInteger) length

readnonatomicassign

Length of route in meters.

name

- (NSString*) name

readnonatomiccopy

Route name. Can be empty for short routes or in case of using server routing.

routePlan

- (NSArray<NMMapCoordinates *>*) routePlan

readnonatomicstrong

Route plan.