HERE iOS SDK Developer's Guide

NMAUrbanMobilityRouter

Class Summary

class NMAUrbanMobilityRouter

Derived from: NMARouter

Urban Mobility-specific route calculation executor.

Include: NMAKit.framework/headers/NMAUrbanMobilityRouter.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAUrbanMobilityRouter

[For complete information, see the section Class Details]

Instance Method Summary

Table 1. Instance Methods
Instance Method Summary

-(nullable NSProgress *) calculateRouteWithStops:(nonnull NSArray< NMAWaypoint * > *) stops routingMode:(nonnull NMARoutingMode *) mode completionBlock:(nonnull NMAUrbanMobilityCalculateResultBlock ) completion

Starts a NMAUrbanMobilityRoute calculation with the given stop list

-(nullable NSProgress *) calculateSubsequentRouteWithRouteResult:(nonnull NMAUrbanMobilityRouteResult *) routeResult withSubsequentRouteType:( NMASubsequentRouteType ) subsequentRouteType withRouteCount:(NSUInteger) routeCount completionBlock:(nonnull NMAUrbanMobilityCalculateResultBlock ) completion

-(nonnull instancetype) init

Class Method Summary

Table 2. Class Methods
Class Methods

+(nonnull instancetype) new

Class Details

Urban Mobility-specific route calculation executor. Defines Urban Mobility specific calculation methods and response listener.

Urban Mobility provides Inter-modal and Multi-modal routes including Public Transit.

IMPORTANT: Urban Mobility routing is a Beta feature. The related classes are subject to change without notice.

Instance Method Details

-(nullable NSProgress *) calculateRouteWithStops:(nonnull NSArray< NMAWaypoint * > *) stops routingMode:(nonnull NMARoutingMode *) mode completionBlock:(nonnull NMAUrbanMobilityCalculateResultBlock ) completion

Starts a NMAUrbanMobilityRoute calculation with the given stop list.

This method returns nil and a route will not be calculated if access to this operation is denied. Contact your HERE representative for more information.

NMARoutingErrorInvalidParameters is returned if new route is requested while the previous one has not yet been completed.

Parameters:

  • stops

    The array of stops used to calculate the route. Must contain exactly two items of type NMAWaypoint otherwise this method returns nil and completes with an error of NMARoutingErrorInvalidParameters.

  • mode

    The NMARoutingMode to use for route calculation

Returns:

NSProgress if route calculation is successfully started, nil otherwise

-(nullable NSProgress *) calculateSubsequentRouteWithRouteResult:(nonnull NMAUrbanMobilityRouteResult *) routeResult withSubsequentRouteType:( NMASubsequentRouteType ) subsequentRouteType withRouteCount:(NSUInteger) routeCount completionBlock:(nonnull NMAUrbanMobilityCalculateResultBlock ) completion

Starts an earlier route calculation, based on service parameters included in NMAUrbanMobilityRouteResult

This method returns nil and a route will not be calculated if access to this operation is denied. Contact your HERE representative for more information.

Parameters:

  • routeResult

    of type NMAUrbanMobilityRouteResult contains parameters (serviceUrl and context) obtained from response of requested route

  • subsequentRouteType

    The NMASubsequentRouteType parameter to force searching earlier or later routes

  • routeCount

    Number of desired route. Given number is just suggestion and the number of route returned is not guaranteed. Allowed range is [1, 6]. Using unsupported value will result error response in route calculation.

Returns:

NSProgress if route calculation is successfully started, nil otherwise

-(nonnull instancetype) init

Initializes an NMAUrbanMobilityRouter instance

Class Method Details

+(nonnull instancetype) new

Initializes an NMAUrbanMobilityRouter instance