HERE iOS SDK Developer's Guide

NMA Routing

Group Summary

group NMA Routing

The Routing group contains classes, protocols, and enumerations for describing and calculating routes.

[For complete information, see the section Group Details]

Nested Classes

Public Enumeration Summary

Table 2. Public Enumerations
Public Enumerations

NMAManeuverAction

Defines types of actions for a NMAManeuver.

NMAManeuverIcon

Defines types of icons for a NMAManeuver.

NMAManeuverTrafficDirection

Defines types of traffic directions, the side of the road on which one must drive.

NMAManeuverTurn

Defines types of turns for a NMAManeuver.

NMARouteDurationDetail

Identifiers for detailed explanation of travel duration (NMARoute::duration) estimates relating to a route.

NMARouteElementType

Defines types of route element.

NMARouteManagerError

Defines types of error codes that can be returned from route calculation operations.

NMARouteViolatedOption

Implicit routing options that may be violated by routes returned from NMARouteManager.

NMARoutingOption

Represents values describing routing options that can be used to enforce special conditions on a calculated route.

NMARoutingType

Represents values describing different routing types.

NMATransportMode

Represents values describing different transport modes, the mode of transportation a person will be using to travel a route (e.g. a car).

Public Variable Summary

Table 3. Public Variables
Public Variables

FOUNDATION_EXPORT NSInteger const  NMARouteSublegWhole

A constant used to indicate the whole route should be used in route leg selection.

Group Details

The Routing group contains classes, protocols, and enumerations for describing and calculating routes. The key class to this group is NMARouteManager.

Public Enumeration Details

NMAManeuverAction

Include: NMAKit.framework/headers/NMAManeuver.h

Defines types of actions for a NMAManeuver.

Enumeration Members:

  • NMAManeuverActionUndefined

    An undefined action.

  • NMAManeuverActionNone

    An indication there is no action associated with the maneuver.

  • NMAManeuverActionEnd

    An action that indicates the end of a route.

  • NMAManeuverActionStopover

    An action that indicates a stopover.

  • NMAManeuverActionJunction

    An action that indicates a junction.

  • NMAManeuverActionRoundabout

    An action that indicates a roundabout.

  • NMAManeuverActionUTurn

    An action that indicates a u-turn.

  • NMAManeuverActionEnterHighwayFromRight

    An action that indicates entering a highway from the right.

  • NMAManeuverActionEnterHighwayFromLeft

    An action that indicates entering a highway from the left.

  • NMAManeuverActionEnterHighway

    An action that indicates entering a highway.

  • NMAManeuverActionLeaveHighway

    An action that indicates leaving a highway.

  • NMAManeuverActionChangeHighway

    An action that indicates changing from one highway to another.

  • NMAManeuverActionContinueHighway

    An action that indicates continuing along a highway.

  • NMAManeuverActionFerry

    An action that indicates boarding a ferry.

  • NMAManeuverActionPassJunction

    An action that indicates passing a junction.

  • NMAManeuverActionInvalid

    An invalid action.

NMAManeuverIcon

Include: NMAKit.framework/headers/NMAManeuver.h

Defines types of icons for a NMAManeuver.

Note:

NMAManeuverIcon enum is simplified version of all valid NMAManeuverAction and NMAManeuverTurn combinations. It can be used to provide navigation directions, but for more detailed representation, use NMAManeuverAction in conjunction with NMAManeuverTurn.

Enumeration Members:

  • NMAManeuverIconUndefined

    An undefined icon.

  • NMAManeuverIconGoStraight

    An icon that indicates a straight heading.

  • NMAManeuverIconUTurnRight

    An icon that indicates a right u-turn.

  • NMAManeuverIconUTurnLeft

    An icon that indicates a left u-turn.

  • NMAManeuverIconKeepRight

    An icon that indicates keeping to the right.

  • NMAManeuverIconLightRight

    An icon that indicates a light right turn.

  • NMAManeuverIconQuiteRight

    An icon that indicates a normal right turn.

  • NMAManeuverIconHeavyRight

    An icon that indicates a heavy right turn.

  • NMAManeuverIconKeepMiddle

    An icon that indicates keeping to the left.

  • NMAManeuverIconKeepLeft

    An icon that indicates keeping to the middle line.

  • NMAManeuverIconLightLeft

    An icon that indicates a light left turn.

  • NMAManeuverIconQuiteLeft

    An icon that indicates a normal left turn.

  • NMAManeuverIconHeavyLeft

    An icon that indicates a heavy left turn.

  • NMAManeuverIconEnterHighwayRightLane

    An icon that indicates entering a highway into the right lane.

  • NMAManeuverIconEnterHighwayLeftLane

    An icon that indicates entering a highway into the left lane.

  • NMAManeuverIconLeaveHighwayRightLane

    An icon that indicates leaving a highway from the right lane.

  • NMAManeuverIconLeaveHighwayLeftLane

    An icon that indicates from the left lane.

  • NMAManeuverIconHighwayKeepRight

    An icon that indicates keeping to the right.

  • NMAManeuverIconHighwayKeepLeft

    An icon that indicates keeping to the left.

  • NMAManeuverIconRoundabout1

    An icon that indicates using the first exit encountered while navigating a roundabout in a counter-clockwise direction.

  • NMAManeuverIconRoundabout2

    An icon that indicates using the second exit encountered while navigating a roundabout in a counter-clockwise direction.

  • NMAManeuverIconRoundabout3

    An icon that indicates using the third exit encountered while navigating a roundabout in a counter-clockwise direction.

  • NMAManeuverIconRoundabout4

    An icon that indicates using the fourth exit encountered while navigating a roundabout in a counter-clockwise direction.

  • NMAManeuverIconRoundabout5

    An icon that indicates using the fifth exit encountered while navigating a roundabout in a counter-clockwise direction.

  • NMAManeuverIconRoundabout6

    An icon that indicates using the sixth exit encountered while navigating a roundabout in a counter-clockwise direction.

  • NMAManeuverIconRoundabout7

    An icon that indicates using the seventh exit encountered while navigating a roundabout in a counter-clockwise direction.

  • NMAManeuverIconRoundabout8

    An icon that indicates using the eighth exit encountered while navigating a roundabout in a counter-clockwise direction.

  • NMAManeuverIconRoundabout9

    An icon that indicates using the ninth exit encountered while navigating a roundabout in a counter-clockwise direction.

  • NMAManeuverIconRoundabout10

    An icon that indicates using the tenth exit encountered while navigating a roundabout in a counter-clockwise direction.

  • NMAManeuverIconRoundabout11

    An icon that indicates using the eleventh exit encountered while navigating a roundabout in a counter-clockwise direction.

  • NMAManeuverIconRoundabout12

    An icon that indicates using the twelfth exit encountered while navigating a roundabout in a counter-clockwise direction.

  • NMAManeuverIconRoundabout1LH

    An icon that indicates using the first exit encountered while navigating a roundabout in a counter-clockwise direction.

  • NMAManeuverIconRoundabout2LH

    An icon that indicates using the second exit encountered while navigating a roundabout in a clockwise direction.

  • NMAManeuverIconRoundabout3LH

    An icon that indicates using the third exit encountered while navigating a roundabout in a clockwise direction.

  • NMAManeuverIconRoundabout4LH

    An icon that indicates using the fourth exit encountered while navigating a roundabout in a clockwise direction.

  • NMAManeuverIconRoundabout5LH

    An icon that indicates using the fifth exit encountered while navigating a roundabout in a clockwise direction.

  • NMAManeuverIconRoundabout6LH

    An icon that indicates using the sixth exit encountered while navigating a roundabout in a clockwise direction.

  • NMAManeuverIconRoundabout7LH

    An icon that indicates using the seventh exit encountered while navigating a roundabout in a clockwise direction.

  • NMAManeuverIconRoundabout8LH

    An icon that indicates using the eighth exit encountered while navigating a roundabout in a clockwise direction.

  • NMAManeuverIconRoundabout9LH

    An icon that indicates using the ninth exit encountered while navigating a roundabout in a clockwise direction.

  • NMAManeuverIconRoundabout10LH

    An icon that indicates using the tenth exit encountered while navigating a roundabout in a clockwise direction.

  • NMAManeuverIconRoundabout11LH

    An icon that indicates using the eleventh exit encountered while navigating a roundabout in a clockwise direction.

  • NMAManeuverIconRoundabout12LH

    An icon that indicates using the twelfth exit encountered while navigating a roundabout in a clockwise direction.

  • NMAManeuverIconStart

    An icon that indicates the start point (displayed when route navigation has not yet begun).

  • NMAManeuverIconEnd

    An icon that indicates the destination point.

  • NMAManeuverIconFerry

    An icon that indicates boarding a ferry.

NMAManeuverTrafficDirection

Include: NMAKit.framework/headers/NMAManeuver.h

Defines types of traffic directions, the side of the road on which one must drive.

Enumeration Members:

  • NMAManeuverTrafficDirectionLeft

    Traffic flows on the left side of the road, as in the UK.

  • NMAManeuverTrafficDirectionRight

    Traffic flows on the right side of the road, as in the USA.

NMAManeuverTurn

Include: NMAKit.framework/headers/NMAManeuver.h

Defines types of turns for a NMAManeuver.

Enumeration Members:

  • NMAManeuverTurnUndefined

    An undefined turn.

  • NMAManeuverTurnNone

    Indicates that no turn is necessary.

  • NMAManeuverTurnKeepMiddle

    A turn that indicates keeping to the middle when a road forks.

  • NMAManeuverTurnKeepRight

    A turn that indicates keeping to the right when a road forks.

  • NMAManeuverTurnLightRight

    A turn that indicates making a light right turn.

  • NMAManeuverTurnQuiteRight

    A turn that indicates making a normal right turn.

  • NMAManeuverTurnHeavyRight

    A turn that indicates making a heavy right turn.

  • NMAManeuverTurnKeepLeft

    A turn that indicates keeping to the left when a road forks.

  • NMAManeuverTurnLightLeft

    A turn that indicates making a light left turn.

  • NMAManeuverTurnQuiteLeft

    A turn that indicates making a normal left turn.

  • NMAManeuverTurnHeavyLeft

    A turn that indicates making a heavy left turn.

  • NMAManeuverTurnReturn

    A turn that indicates a u-turn, turning around.

  • NMAManeuverTurnRoundabout1

    A turn that indicates taking the first exit of a roundabout.

  • NMAManeuverTurnRoundabout2

    A turn that indicates taking the second exit of a roundabout.

  • NMAManeuverTurnRoundabout3

    A turn that indicates taking the third exit of a roundabout.

  • NMAManeuverTurnRoundabout4

    A turn that indicates taking the fourth exit of a roundabout.

  • NMAManeuverTurnRoundabout5

    A turn that indicates taking the fifth exit of a roundabout.

  • NMAManeuverTurnRoundabout6

    A turn that indicates taking the sixth exit of a roundabout.

  • NMAManeuverTurnRoundabout7

    A turn that indicates taking the seventh exit of a roundabout.

  • NMAManeuverTurnRoundabout8

    A turn that indicates taking the eighth exit of a roundabout.

  • NMAManeuverTurnRoundabout9

    A turn that indicates taking the ninth exit of a roundabout.

  • NMAManeuverTurnRoundabout10

    A turn that indicates taking the tenth exit of a roundabout.

  • NMAManeuverTurnRoundabout11

    A turn that indicates taking the eleventh exit of a roundabout.

  • NMAManeuverTurnRoundabout12

    A turn that indicates taking the twelfth exit of a roundabout.

NMARouteDurationDetail

Include: NMAKit.framework/headers/NMARouteTta.h

Identifiers for detailed explanation of travel duration (NMARoute::duration) estimates relating to a route.

Note:

This is a bitwise enum. If none of the bit is set, NMARouteDurationDetailAccurate is assumed

Enumeration Members:

  • NMARouteDurationDetailAccurate

    The estimate is accurate.

  • NMARouteDurationDetailBlockedRoad

    The route uses a road that is blocked.

  • NMARouteDurationDetailCarPool

    The route uses a road with carpool restriction.

  • NMARouteDurationDetailRestrictedTurn

    The route uses a restricted turn.

NMARouteElementType

Include: NMAKit.framework/headers/NMARouteElement.h

Defines types of route element.

Enumeration Members:

  • NMARouteElementRoad

    Road Element

  • NMARouteElementInvalid

    invalid

NMARouteManagerError

Include: NMAKit.framework/headers/NMARouteManager.h

Defines types of error codes that can be returned from route calculation operations.

Enumeration Members:

  • NMARouteManagerErrorNone

    There was no error, route calculation succeeded.

  • NMARouteManagerErrorUnknown

    There was an unknown error.

  • NMARouteManagerErrorOutOfMemory

    There was an out-of-memory error.

  • NMARouteManagerErrorInvalidParameters

    There was an error due to invalid parameters.

  • NMARouteManagerErrorInvalidOperation

    There was an error due to another request already being processed.

  • NMARouteManagerErrorGraphDisconnected

    There was an error because no route could be found.

  • NMARouteManagerErrorGraphDisconnectedCheckOptions

    There was an error because no route could be found, possibly due to some option (e.g. disabled highways) preventing it.

  • NMARouteManagerErrorNoStartPoint

    There was an error because no starting waypoint could be found.

  • NMARouteManagerErrorNoEndPoint

    There was an error because no destination waypoint could be found.

  • NMARouteManagerErrorNoEndPointCheckOptions

    There was an error because the destination point is unreachable, possibly due to some option (e.g. disabled highways) preventing it.

  • NMARouteManagerErrorCannotDoPedestrian

    There was an error because pedestrian mode was specified yet is not practical (e.g. the route is too long).

  • NMARouteManagerErrorRoutingCancelled

    There was an error because the application user cancelled the route calculation.

  • NMARouteManagerErrorViolatesOptions

    There was an error because the route calculation request included options that prohibit successful completion.

  • NMARouteManagerErrorRouteCorrupted

    There was an error because the service could not digest the requested route parameters.

  • NMARouteManagerErrorInvalidCredentials

    There was an error due to invalid or missing HERE Developer credentials.

NMARouteViolatedOption

Include: NMAKit.framework/headers/NMARouteManager.h

Implicit routing options that may be violated by routes returned from NMARouteManager.

Enumeration Members:

  • NMARouteViolatedOptionNone

    The returned route does not violate any options

  • NMARouteViolatedOptionBlockedRoad

    The route passes through a blocked road (e.g. due to construction)

  • NMARouteViolatedOptionTurnRestriction

    The route passes through a road with a time-based turn restriction

NMARoutingOption

Include: NMAKit.framework/headers/NMARoutingMode.h

Represents values describing routing options that can be used to enforce special conditions on a calculated route.

Enumeration Members:

  • NMARoutingOptionAvoidBoatFerry

    The routing engine will avoid links that are part of a boat ferry passage.

  • NMARoutingOptionAvoidDirtRoad

    The routing engine will avoid links that are part of a dirt road.

  • NMARoutingOptionAvoidHighway

    The routing engine will avoid links that are part of a highway.

    Note:

    Effective only when used with NMATransportModeCar.

  • NMARoutingOptionAvoidPark

    The routing engine will avoid links that go through a park.

    Note:

    Effective only when used with NMATransportModePedestrian.

  • NMARoutingOptionAvoidTollRoad

    The routing engine will avoid links that are part of a toll road.

    Note:

    Effective only when used with NMATransportModeCar.

  • NMARoutingOptionAvoidTunnel

    The routing engine will avoid links that are part of a tunnel.

    Note:

    Effective only when used with NMATransportModeCar.

  • NMARoutingOptionAvoidCarShuttleTrain

    The routing engine will avoid links that are part of a motorail train or car shuttle train passage.

  • NMARoutingOptionAvoidCarpool

    The routing engine will avoid HOV/Carpool roads.

NMARoutingType

Include: NMAKit.framework/headers/NMARoutingMode.h

Represents values describing different routing types.

Enumeration Members:

  • NMARoutingTypeShortest

    Search for the shortest route, taking road conditions and restrictions into account (minimizes travel distance).

  • NMARoutingTypeFastest

    Search for the fastest route, taking road conditions and restrictions into account (minimizes travel time).

NMATransportMode

Include: NMAKit.framework/headers/NMARoutingMode.h

Represents values describing different transport modes, the mode of transportation a person will be using to travel a route (e.g. a car).

Enumeration Members:

  • NMATransportModeCar

    A car is being used as the mode of transportation.

  • NMATransportModePedestrian

    Walking is being used as the mode of transportation.

Public Variable Details

FOUNDATION_EXPORT NSInteger const NMARouteSublegWhole

Include: NMAKit.framework/headers/NMARoute.h

A constant used to indicate the whole route should be used in route leg selection.

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.