HERE iOS SDK Developer's Guide

NMAVenue3dCombinedRoute

Class Summary

class NMAVenue3dCombinedRoute

Derived from: NSObject

Describes route from start to end point. The route is split into one or more route sections.

Include: NMAKit.framework/headers/NMAVenue3dCombinedRoute.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAVenue3dCombinedRoute

[For complete information, see the section Class Details]

See also:

NMAVenue3dRoutingController

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, assign] NSArray< NMAVenue3dRouteSection * > *  routeSections

The array of NMAVenue3dRouteSection objects for this route

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(BOOL) conformsConnectorOptions

Returns YES if the returned route does no use any accessors set to be avoided in NMAVenue3dRouteOptions

-(BOOL) conformsModeOptions

Returns YES if the returned route for every outdoor section except to/from parking, is the mode user has requested

-( NMARoutingError ) getCoreMapError

Returns NMARoutingError, indicating inner core map error

-(nonnull NMAVenue3dBaseLocation *) getEnd

Returns a NMAVenue3dBaseLocation associated with end point of the route

-( NMAVenue3dRoutingError ) getError

Returns NMAVenue3dRoutingError indicating route computation result

-(NSInteger) getLength

Returns the length of the route in meters

-(nonnull NMAVenue3dBaseLocation *) getStart

Returns a NMAVenue3dBaseLocation associated with start point of the route

-(nonnull NSArray< NMAVenue3dBaseLocation * > *) getWaypoints

Returns the array of NMAVenue3dBaseLocation objects associated with waypoints on the route including start and end points

-(nonnull instancetype) init

Class Method Summary

Table 3. Class Methods
Class Methods

+(nonnull instancetype) new

Class Details

Describes route from start to end point. The route is split into one or more route sections.

 

See also:

NMAVenue3dRoutingController

Public Property Details

[readable, assign] NSArray< NMAVenue3dRouteSection * > * routeSections

The array of NMAVenue3dRouteSection objects for this route.

This information can be used to check type of turn-by-turn information available for each route section of the combined route.

Instance Method Details

-(BOOL) conformsConnectorOptions

Returns YES if the returned route does no use any accessors set to be avoided in NMAVenue3dRouteOptions.

In certain cases no route can be created that satisfies all route options when it comes to use of elevators, escalators, stairs and ramps. If any of these are set to be avoided, this methdod can be used to check if the calculated route still uses any of these accessors.

-(BOOL) conformsModeOptions

Returns YES if the returned route for every outdoor section except to/from parking, is the mode user has requested.

In certain cases pedestrian mode is preferred over drive mode when distance to/from street is greater than the direct walking distance and drive distance is less than a certain threshold (ex. 2m). This method can be used to check if any segment is of pedestrian type in drive mode.

-( NMARoutingError ) getCoreMapError

Returns NMARoutingError, indicating inner core map error. This function should be used only when the method getError returns the error code NMAVenue3dRoutingErrorCoreMap.

-(nonnull NMAVenue3dBaseLocation *) getEnd

Returns a NMAVenue3dBaseLocation associated with end point of the route.

-( NMAVenue3dRoutingError ) getError

Returns NMAVenue3dRoutingError indicating route computation result.

-(NSInteger) getLength

Returns the length of the route in meters.

-(nonnull NMAVenue3dBaseLocation *) getStart

Returns a NMAVenue3dBaseLocation associated with start point of the route.

-(nonnull NSArray< NMAVenue3dBaseLocation * > *) getWaypoints

Returns the array of NMAVenue3dBaseLocation objects associated with waypoints on the route including start and end points.

-(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