NMRouteCalculationFailureInfo Class Reference

Inherits <NSObject>.

Instance Methods
(nullable instancetype)	- NS_UNAVAILABLE

Class Methods
(nullable instancetype)	+ NS_UNAVAILABLE

Properties
NMRouteCalculationError	errorCode
NSArray< NSNumber * > *	routePlanPointIndicesFailedToSnap

Detailed Description

Interface describing unsuccessful route calculation result.

Method Documentation

NS_UNAVAILABLE() [1/2]

- (nullable instancetype) NS_UNAVAILABLE

Default initialization is forbidden.

NS_UNAVAILABLE() [2/2]

+ (nullable instancetype) NS_UNAVAILABLE

Property Documentation

errorCode

- (NMRouteCalculationError) errorCode

readnonatomicassign

Returns the code of an error caused route calculation failure.

routePlanPointIndicesFailedToSnap

- (NSArray<NSNumber *>*) routePlanPointIndicesFailedToSnap

readnonatomicstrong

If errorCode property returns NMRouteCalculationError_NoRoadNearWaypoint, the property returns the list of waypoint indices in initial route plan that route calculation service couldn't snap to the map (i.e. no road exist near waypoint, etc.). Otherwise empty list is returned.

Note

In current implementation only the first failed waypoint index is returned.