HERE iOS SDK Developer's Guide

NMARoute

Class Summary

class NMARoute

Derived from: NSObject

Represents a path (a collection of maneuvers) connecting two or more waypoints.

Include: NMAKit.framework/headers/NMARoute.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMARoute

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, assign] NMAGeoBoundingBox boundingBox

The smallest NMAGeoBoundingBox that contains the entire NMARoute

[readable, assign] NMAWaypoint destination

The destination NMAWaypoint for the NMARoute

[readable, assign] NSUInteger  length

The length of the NMARoute, in meters

[readable, assign] NSArray< NMAManeuver * > *  maneuvers

Array of NMAManeuver to represent all the maneuvers that travelers will encounter along the NMARoute

[readable, assign] NMAMapPolyline mapPolyline

The NMAMapPolyline representation of the route

[readable, assign] NMARoutingMode routingMode

The NMARoutingMode for the NMARoute

[readable, assign] NMAWaypoint start

The starting NMAWaypoint for the NMARoute.

[readable, assign] NSUInteger  sublegCount

Returns the number of sub-legs the route has a subleg is the part of a route between two stop waypoints

[readable, assign] NMARouteTta tta

The NMARouteTta object of traveling the whole NMARoute.

[readable, writable, strong] NSString *  userTag

[readable, assign] NSArray< NMAWaypoint * > *  waypoints

Array of NMAWaypoint for all waypoints of the NMARoute

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nullable NMARouteTta *) ttaForSubleg:(NSUInteger) subleg

The NMARouteTta object of traveling the specified subLeg of the NMARoute.

Class Details

Represents a path (a collection of maneuvers) connecting two or more waypoints.

Waypoints may be thought of as the input to a route calculation whereas maneuvers are the results of calculating a route.

Public Property Details

[readable, assign] NMAGeoBoundingBoxboundingBox

The smallest NMAGeoBoundingBox that contains the entire NMARoute.

[readable, assign] NMAWaypointdestination

The destination NMAWaypoint for the NMARoute.

[readable, assign] NSUInteger length

The length of the NMARoute, in meters. This is the actual distance covered if you were to travel the route.

[readable, assign] NSArray< NMAManeuver * > * maneuvers

Array of NMAManeuver to represent all the maneuvers that travelers will encounter along the NMARoute.

[readable, assign] NMAMapPolylinemapPolyline

The NMAMapPolyline representation of the route.

[readable, assign] NMARoutingModeroutingMode

The NMARoutingMode for the NMARoute.

[readable, assign] NMAWaypointstart

The starting NMAWaypoint for the NMARoute.

[readable, assign] NSUInteger sublegCount

Returns the number of sub-legs the route has a subleg is the part of a route between two stop waypoints.

[readable, assign] NMARouteTtatta

The NMARouteTta object of traveling the whole NMARoute.

[readable, writable, strong] NSString * userTag

A user-defined tag to identify the NMARoute

Note:

The default value for userTag is empty string.

[readable, assign] NSArray< NMAWaypoint * > * waypoints

Array of NMAWaypoint for all waypoints of the NMARoute.

Instance Method Details

-(nullable NMARouteTta *) ttaForSubleg:(NSUInteger) subleg

The NMARouteTta object of traveling the specified subLeg of the NMARoute.

Parameters:

  • subleg

    The index of the subleg on the NMARoute to be used for this calculation. If NMARouteSublegWhole is provided, it is the same as tta property.

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.