HERE iOS SDK Developer's Guide

NMAWaypoint

Class Summary

class NMAWaypoint

Derived from: NSObject

Waypoints define a route's stopovers, including its start point it's destination point and any points in between.

Include: NMAKit.framework/headers/NMAWaypoint.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMAWaypoint

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, assign] NMAGeoCoordinates mappedPosition

The NMAGeoCoordinates representing the mapped matched position of the NMAWaypoint - the coordinates adjusted by the routing engine so that they fall upon a road

[readable, writable, assign] NMAGeoCoordinates navigablePosition

The NMAGeoCoordinates representing the suggested navigable position of the NMAWaypoint - typically the coordinates on the road closest to the original position - to be used in a route calculation

[readable, writable, assign] NMAGeoCoordinates originalPosition

The NMAGeoCoordinates representing the original position of the NMAWaypoint - typically the exact coordinates of a building

[readable, assign] NMAWaypointRoadInfo roadInfo

The NMAWaypointRoadInfo representing additional information about an NMAWaypoint, obtained during route calculation

[readable, writable, assign] NMAWaypointType   waypointType

Determines the waypoint type

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nonnull) init

Initializes a STOP NMAWaypoint instance

-(nonnull) initWithGeoCoordinates:(nonnull NMAGeoCoordinates *) position

Initializes an NMAWaypoint instance of type NMAStopWaypoint with the specified coordinates

-(nonnull) initWithGeoCoordinates:(nonnull NMAGeoCoordinates *) position waypointType:( NMAWaypointType ) type

Initializes an NMAWaypoint instance with the specified geocoordinates and type

Class Details

Waypoints define a route's stopovers, including its start point it's destination point and any points in between.

Each waypoint represents a position along an NMARoute, this includes:
  • The original (input) coordinates specified as part of a search request and
  • The navigable (input) coordinates representing the coordinates on the road

Public Property Details

[readable, assign] NMAGeoCoordinatesmappedPosition

The NMAGeoCoordinates representing the mapped matched position of the NMAWaypoint - the coordinates adjusted by the routing engine so that they fall upon a road.

This is different than the navigablePosition because this is a value that is generated during the routing calculation.

Note:

This is nil before route calculation. This is only available after route calculation.

[readable, writable, assign] NMAGeoCoordinatesnavigablePosition

The NMAGeoCoordinates representing the suggested navigable position of the NMAWaypoint - typically the coordinates on the road closest to the original position - to be used in a route calculation.

For a waypoint that is not on a road, the navigable position acts as a road location hint for a route calculation. However, there's no guarantee that any location can work as a navigable position. It is best to only use a navigable position when you have a trusted source, such as from search results.

Working together with the navigable position, the original position is used by the HERE SDK for determining the side of street during arrival, and to let the calculated route approach the correct side of street, especially when there there is a physical or logical lane divider on the road.

By default, the navigable position is set to be same as the geocoordinates provided during construction of this NMAWaypoint.

Attempts to set the property to nil will be ignored.

See also NMAPlaceLocation.

[readable, writable, assign] NMAGeoCoordinatesoriginalPosition

The NMAGeoCoordinates representing the original position of the NMAWaypoint - typically the exact coordinates of a building.

The original position is required for a route calculation. By default, this is set to be the same as the geocoordinates provided during construction of this NMAWaypoint.

Working together with the navigable position, the original position is used by the HERE SDK for determining the side of street during arrival, and to let the calculated route approach the correct side of street, especially when there there is a physical or logical lane divider on the road.

Attempts to set the property to nil will be ignored.

See also NMAPlaceLocation.

[readable, assign] NMAWaypointRoadInforoadInfo

The NMAWaypointRoadInfo representing additional information about an NMAWaypoint, obtained during route calculation.

Note:

This is nil before route calculation. This is only available after route calculation.

[readable, writable, assign] NMAWaypointType  waypointType

Determines the waypoint type.

Note:

The default value is NMAStopWaypoint.

See also:

NMAWaypointType

Instance Method Details

-(nonnull) init

Initializes a STOP NMAWaypoint instance.

Set at least the originalPosition property for this waypoint to be useful.

-(nonnull) initWithGeoCoordinates:(nonnull NMAGeoCoordinates *) position

Initializes an NMAWaypoint instance of type NMAStopWaypoint with the specified coordinates.

Parameters:

  • position

    Coordinates of the waypoint, must not be nil.

Returns:

NMAWaypoint instance.

-(nonnull) initWithGeoCoordinates:(nonnull NMAGeoCoordinates *) position waypointType:( NMAWaypointType ) type

Initializes an NMAWaypoint instance with the specified geocoordinates and type.

Parameters:

  • position

    Coordinates of the waypoint, must not be nil.

  • type

    Waypoint type.

Returns:

NMAWaypoint instance.

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.