NMExternalRoutePoint Class Reference

Inherits <NSObject>, and <NSCopying>.

Instance Methods
(nullable instancetype)	- NS_UNAVAILABLE
(nullable instancetype)	- initWithCoordinates:durationFromStart:
(nullable instancetype)	- initWaypointWithCoordinates:durationFromStart:
(nullable instancetype)	- initWithCoordinates:durationFromStart:isWaypoint:

Class Methods
(nullable instancetype)	+ NS_UNAVAILABLE
(nullable instancetype)	+ pointWithCoordinates:durationFromStart:
(nullable instancetype)	+ waypointWithCoordinates:durationFromStart:
(nullable instancetype)	+ pointWithCoordinates:durationFromStart:isWaypoint:

Properties
NMMapCoordinates *	coordinates
float	durationFromStartInSeconds
BOOL	isWaypoint

Detailed Description

Interface representing an external route point.

Method Documentation

initWaypointWithCoordinates:durationFromStart:()

- (nullable instancetype) initWaypointWithCoordinates:		(nonnull NMMapCoordinates *)	coordinates
durationFromStart:		(float)	durationFromStartInSeconds

Initializes a route waypoint with the specified geo coordinates and duration from the route start point.

Parameters

coordinates	@nonnull The geo coordinates of a point.
durationFromStartInSeconds	The duration from the route start point to a point being created, in seconds.

Returns

New route waypoint.

initWithCoordinates:durationFromStart:()

- (nullable instancetype) initWithCoordinates:		(nonnull NMMapCoordinates *)	coordinates
durationFromStart:		(float)	durationFromStartInSeconds

Initializes a regular route point with the specified geo coordinates and duration from the route start point.

Parameters

coordinates	@nonnull The geo coordinates of a point.
durationFromStartInSeconds	The duration from the route start point to a point being created, in seconds.

Returns

New route point.

initWithCoordinates:durationFromStart:isWaypoint:()

- (nullable instancetype) initWithCoordinates:		(nonnull NMMapCoordinates *)	coordinates
durationFromStart:		(float)	durationFromStartInSeconds
isWaypoint:		(BOOL)	isWaypoint

Initializes a route point with the specified geo coordinates and duration from the route start point.

Parameters

coordinates	@nonnull The geo coordinates of a point.
durationFromStartInSeconds	The duration from the route start point to a point being created, in seconds.
isWaypoint	Indicates whether the point is a regular route point or a waypoint.

Returns

New route point.

NS_UNAVAILABLE() [1/2]

+ (nullable instancetype) NS_UNAVAILABLE

Default initialization is forbidden.

NS_UNAVAILABLE() [2/2]

- (nullable instancetype) NS_UNAVAILABLE

Default initialization is forbidden.

pointWithCoordinates:durationFromStart:()

+ (nullable instancetype) pointWithCoordinates:		(nonnull NMMapCoordinates *)	coordinates
durationFromStart:		(float)	durationFromStartInSeconds

Creates a regular route point with the specified geo coordinates and duration from the route start point.

Parameters

coordinates	@nonnull The geo coordinates of a point.
durationFromStartInSeconds	The duration from the route start point to a point being created, in seconds.

Returns

New route point.

pointWithCoordinates:durationFromStart:isWaypoint:()

+ (nullable instancetype) pointWithCoordinates:		(nonnull NMMapCoordinates *)	coordinates
durationFromStart:		(float)	durationFromStartInSeconds
isWaypoint:		(BOOL)	isWaypoint

Creates a route point with the specified geo coordinates and duration from the route start point.

Parameters

coordinates	@nonnull The geo coordinates of a point.
durationFromStartInSeconds	The duration from the route start point to a point being created, in seconds.
isWaypoint	Indicates whether the point is a regular route point or a waypoint.

Returns

New route point.

waypointWithCoordinates:durationFromStart:()

+ (nullable instancetype) waypointWithCoordinates:		(nonnull NMMapCoordinates *)	coordinates
durationFromStart:		(float)	durationFromStartInSeconds

Creates a route waypoint with the specified geo coordinates and duration from the route start point.

Parameters

coordinates	@nonnull The geo coordinates of a point.
durationFromStartInSeconds	The duration from the route start point to a point being created, in seconds.

Returns

New route waypoint.

Property Documentation

coordinates

- (NMMapCoordinates*) coordinates

readnonatomicstrong

The geo coordinates of a route point.

durationFromStartInSeconds

- (float) durationFromStartInSeconds

readnonatomicassign

The duration from the route start point to the point, in seconds.

isWaypoint

- (BOOL) isWaypoint

readwritenonatomicassign

Indicates whether the point is a waypoint of a route or a regular route point.

Default value is 'NO'.