HERE iOS SDK Developer's Guide

NMARouteResult

Class Summary

class NMARouteResult

Derived from: NSObject

Contains the result for a routing query.

Include: NMAKit.framework/headers/NMARouteResult.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMARouteResult

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, assign] NSArray< NMARoute * > *  routes

An NSArray of NMARoute objects representing alternate route solutions, or nil if route calculation failed

[readable, assign] NSArray< NSNumber * > *  violatedOptions

NSArray of NSNumber objects, one per route calculated, representing which options (if any) were violated for the corresponding route

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nonnull instancetype) init

Class Method Summary

Table 3. Class Methods
Class Methods

+(nonnull instancetype) new

Class Details

Contains the result for a routing query.

Public Property Details

[readable, assign] NSArray< NMARoute * > * routes

An NSArray of NMARoute objects representing alternate route solutions, or nil if route calculation failed. The route at index 0 is the best result found. The number of routes in the array will be less than or equal to the resultCount property specified in the NMARoutingMode used for the route request. Only one result will be returned for routes with more than two waypoints. (Note that NMATransitRoute objects are returned for public transport routing only. Applications must show sourceAttribution info of NMATransitRoute if it is available).

[readable, assign] NSArray< NSNumber * > * violatedOptions

NSArray of NSNumber objects, one per route calculated, representing which options (if any) were violated for the corresponding route. The NSNumber objects should be converted to NSUInteger before checking. The value will be an OR combination of NMARoutingOption and NMARoutingViolatedOption values, or NMARoutingViolatedOptionNone if no options were violated. If route calculation failed, the array will contain a single object containing all the routing options (if any).

Instance Method Details

-(nonnull instancetype) init

Instances of this class should not be initialized directly

Class Method Details

+(nonnull instancetype) new

Instances of this class should not be initialized directly