NMExternalRoute Class Reference

Inherits <NSObject>.

Instance Methods
(nullable instancetype)	- NS_UNAVAILABLE
(nullable instancetype)	- initWithDuration:routePoints:
(nullable instancetype)	- initWithDuration:routePoints:mayContainSelfIntersections:
(nullable instancetype)	- initWithDuration:durationIgnoringTrafficDelay:routePoints:
(nullable instancetype)	- initWithDuration:durationIgnoringTrafficDelay:routePoints:mayContainSelfIntersections:

Class Methods
(nullable instancetype)	+ NS_UNAVAILABLE
(nullable instancetype)	+ routeWithDuration:routePoints:
(nullable instancetype)	+ routeWithDuration:routePoints:mayContainSelfIntersections:
(nullable instancetype)	+ routeWithDuration:durationIgnoringTrafficDelay:routePoints:
(nullable instancetype)	+ routeWithDuration:durationIgnoringTrafficDelay:routePoints:mayContainSelfIntersections:

Properties
float	durationInSeconds
float	durationIgnoringTrafficDelayInSeconds
NSArray< NMExternalRoutePoint * > *	routePoints
BOOL	mayContainSelfIntersections

Detailed Description

Interface representing an external route.

Method Documentation

initWithDuration:durationIgnoringTrafficDelay:routePoints:()

- (nullable instancetype) initWithDuration:		(float)	durationInSeconds
durationIgnoringTrafficDelay:		(float)	durationIgnoringTrafficDelayInSeconds
routePoints:		(nonnull NSArray< NMExternalRoutePoint * > *)	routePoints

Initializes a class instance with the specified duration, duration ignoring traffic delay and route points with no self-intersections.

Parameters

durationInSeconds	The duration of the route, in seconds;
durationIgnoringTrafficDelayInSeconds	The duration of the route ignoring traffic delay, in seconds;
routePoints	@nonnull The list of route points.

Returns

New external route.

initWithDuration:durationIgnoringTrafficDelay:routePoints:mayContainSelfIntersections:()

- (nullable instancetype) initWithDuration:		(float)	durationInSeconds
durationIgnoringTrafficDelay:		(float)	durationIgnoringTrafficDelayInSeconds
routePoints:		(nonnull NSArray< NMExternalRoutePoint * > *)	routePoints
mayContainSelfIntersections:		(BOOL)	mayContainSelfIntersections

Initializes a class instance with the specified duration, duration ignoring traffic delay and route points with or without self-intersections.

Parameters

durationInSeconds	The duration of the route, in seconds;
durationIgnoringTrafficDelayInSeconds	The duration of the route ignoring traffic delay, in seconds;
routePoints	@nonnull The list of route points;
mayContainSelfIntersections	Indicates whether @routePoints may contain self-intersections.

Returns

New external route.

initWithDuration:routePoints:()

- (nullable instancetype) initWithDuration:		(float)	durationInSeconds
routePoints:		(nonnull NSArray< NMExternalRoutePoint * > *)	routePoints

Initializes a class instance with the specified duration and route points with no self-intersection.

Parameters

durationInSeconds	The duration of the route, in seconds;
routePoints	@nonnull The list of route points.

Returns

New external route.

initWithDuration:routePoints:mayContainSelfIntersections:()

- (nullable instancetype) initWithDuration:		(float)	durationInSeconds
routePoints:		(nonnull NSArray< NMExternalRoutePoint * > *)	routePoints
mayContainSelfIntersections:		(BOOL)	mayContainSelfIntersections

Initializes a class instance with the specified duration and route points with or without self-intersections.

Parameters

durationInSeconds	The duration of the route, in seconds;
routePoints	@nonnull The list of route points;
mayContainSelfIntersections	Indicates whether @routePoints may contain self-intersections.

Returns

New external route.

NS_UNAVAILABLE() [1/2]

+ (nullable instancetype) NS_UNAVAILABLE

Default initialization is forbidden.

NS_UNAVAILABLE() [2/2]

- (nullable instancetype) NS_UNAVAILABLE

Default initialization is forbidden.

routeWithDuration:durationIgnoringTrafficDelay:routePoints:()

+ (nullable instancetype) routeWithDuration:		(float)	durationInSeconds
durationIgnoringTrafficDelay:		(float)	durationIgnoringTrafficDelayInSeconds
routePoints:		(nonnull NSArray< NMExternalRoutePoint * > *)	routePoints

Creates a class instance with the specified duration, duration ignoring traffic delay and route points with no self-intersections.

Parameters

durationInSeconds	The duration of the route, in seconds;
routePoints	@nonnull The list of route points.

Returns

New external route.

routeWithDuration:durationIgnoringTrafficDelay:routePoints:mayContainSelfIntersections:()

+ (nullable instancetype) routeWithDuration:		(float)	durationInSeconds
durationIgnoringTrafficDelay:		(float)	durationIgnoringTrafficDelayInSeconds
routePoints:		(nonnull NSArray< NMExternalRoutePoint * > *)	routePoints
mayContainSelfIntersections:		(BOOL)	mayContainSelfIntersections

Creates a class instance with the specified duration, duration ignoring traffic delay and route points with or without self-intersections.

Parameters

durationInSeconds	The duration of the route, in seconds;
routePoints	@nonnull The list of route points;
mayContainSelfIntersections	Indicates whether @routePoints may contain self-intersections.

Returns

New external route.

routeWithDuration:routePoints:()

+ (nullable instancetype) routeWithDuration:		(float)	durationInSeconds
routePoints:		(nonnull NSArray< NMExternalRoutePoint * > *)	routePoints

Creates a class instance with the specified duration and route points with no self-intersections.

Parameters

durationInSeconds	The duration of the route, in seconds;
routePoints	@nonnull The list of route points.

Returns

New external route.

routeWithDuration:routePoints:mayContainSelfIntersections:()

+ (nullable instancetype) routeWithDuration:		(float)	durationInSeconds
routePoints:		(nonnull NSArray< NMExternalRoutePoint * > *)	routePoints
mayContainSelfIntersections:		(BOOL)	mayContainSelfIntersections

Creates a class instance with the specified duration and route points with or without self-intersections.

Parameters

durationInSeconds	The duration of the route, in seconds;
routePoints	@nonnull The list of route points;
mayContainSelfIntersections	Indicates whether @routePoints may contain self-intersections.

Returns

New external route.

Property Documentation

durationIgnoringTrafficDelayInSeconds

- (float) durationIgnoringTrafficDelayInSeconds

readnonatomicassign

Total route duration with no traffic delays, in seconds.

Default value is zero indicating duration ignoring traffic delay is not available.

durationInSeconds

- (float) durationInSeconds

readnonatomicassign

Total route duration, in seconds.

mayContainSelfIntersections

- (BOOL) mayContainSelfIntersections

readnonatomicassign

Flag indicating whether @routePoints may contain self-intersections.

Default value is 'NO' indicating @routePoints array contains no self-intersections.

routePoints

- (NSArray<NMExternalRoutePoint *>*) routePoints

readnonatomicstrong

An array of route points.