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
[For complete information, see the section Class Details]
Public Property Summary
| Public Properties |
|---|
| [readable, assign] Gets the identifier |
| [readable, assign] 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] 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] The NMAGeoCoordinates representing the original position of the NMAWaypoint - typically the exact coordinates of a building |
| [readable, assign] The NMAWaypointRoadInfo representing additional information about an NMAWaypoint, obtained during route calculation |
| [readable, assign] Gets the direction for waypoint |
| [readable, writable, assign] Determines the waypoint type |
Instance Method Summary
| Instance Method Summary |
|---|
| Initializes a STOP NMAWaypoint instance |
| Initializes an NMAWaypoint instance of type NMAStopWaypoint with the specified coordinates |
| Initializes an NMAWaypoint instance with the specified geocoordinates and type |
| Initializes an NMAWaypoint instance with the specified geocoordinates and type |
| Sets the road element identifier and direction |
Class Details
Waypoints define a route's stopovers, including its start point it's destination point and any points in between.
- 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] NSString * identifier
Gets the identifier.
[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.
This is different than the navigablePosition because this is a value that is generated during the routing calculation.
This is nil before route calculation. This is only available after route calculation.
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] NMAGeoCoordinates * originalPosition
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] NMAWaypointRoadInfo * roadInfo
The NMAWaypointRoadInfo representing additional information about an NMAWaypoint, obtained during route calculation.
This is nil before route calculation. This is only available after route calculation.
[readable, assign] NMAWaypointDirection waypointDirection
Gets the direction for waypoint.
[readable, writable, assign] NMAWaypointType waypointType
Determines the waypoint type.
The default value is NMAStopWaypoint.
See also:
Instance Method Details
-(nonnull instancetype) init
Initializes a STOP NMAWaypoint instance.
Set at least the originalPosition property for this waypoint to be useful.
-(nonnull instancetype) initWithGeoCoordinates:(nonnull NMAGeoCoordinates *) position
Initializes an NMAWaypoint instance of type NMAStopWaypoint with the specified coordinates.
Parameters:
-
positionCoordinates of the waypoint, must not be nil.
Returns:
NMAWaypoint instance.
-(nonnull instancetype) initWithGeoCoordinates:(nonnull NMAGeoCoordinates *) position identifier:(nonnull NSString *) uniqueId waypointDirection:( NMAWaypointDirection ) direction waypointType:( NMAWaypointType ) type
Initializes an NMAWaypoint instance with the specified geocoordinates and type.
Parameters:
-
positionCoordinates of the waypoint, must not be nil.
-
typeWaypoint type.
Returns:
NMAWaypoint instance.
-(nonnull instancetype) initWithGeoCoordinates:(nonnull NMAGeoCoordinates *) position waypointType:( NMAWaypointType ) type
Initializes an NMAWaypoint instance with the specified geocoordinates and type.
Parameters:
-
positionCoordinates of the waypoint, must not be nil.
-
typeWaypoint type.
Returns:
NMAWaypoint instance.
-(void) setIdentifier:(nonnull NSString *) identifier waypointDirection:( NMAWaypointDirection ) direction
Sets the road element identifier and direction. This information will be used in route calculation.
Parameters:
-
identifier- Road element identifier
-
direction- Direction to be enforeced