HERE iOS SDK Developer's Guide

NMARoutingMode

Class Summary

class NMARoutingMode

Derived from: NSObject

.

Include: NMAKit.framework/headers/NMARoutingMode.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMARoutingMode

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, writable, strong] NSDate *  departureTime

The desired departure time

[readable, writable, assign] NSUInteger  resultLimit

The maximum number of alternative routes to calculate

[readable, writable, assign] NSUInteger  routingOptions

The OR-ed NMARoutingOption values for the NMARoutingMode

[readable, writable, assign] NMARoutingType   routingType

The NMARoutingType for the NMARoutingMode

[readable, writable, assign] NMATransportMode   transportMode

The NMATransportMode for the NMARoutingMode

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(id) init

Initializes a NMARoutingMode instance with default values

-(id) initWithRoutingType:( NMARoutingType ) routingType transportMode:( NMATransportMode ) transportMode routingOptions:(NSUInteger) routingOptions

Initializes a NMARoutingMode instance with the specified routing parameters

Class Details

Represents a model of the parameters required for one route calculation, encapsulating parameters such as:

Public Property Details

[readable, writable, strong] NSDate * departureTime

The desired departure time.

[readable, writable, assign] NSUInteger resultLimit

The maximum number of alternative routes to calculate. The actual number calculated may be less. The default value is 1.

Note:

Only one result will be returned for routes with more than two waypoints.

[readable, writable, assign] NSUInteger routingOptions

The OR-ed NMARoutingOption values for the NMARoutingMode.

Note:

The default value is 0 (no options selected).

[readable, writable, assign] NMARoutingType  routingType

The NMARoutingType for the NMARoutingMode.

Note:

The default value is NMARoutingTypeShortest.

[readable, writable, assign] NMATransportMode  transportMode

The NMATransportMode for the NMARoutingMode.

Note:

The default value is NMATransportModeCar.

Instance Method Details

-(id) init

Initializes a NMARoutingMode instance with default values.

-(id) initWithRoutingType:( NMARoutingType ) routingType transportMode:( NMATransportMode ) transportMode routingOptions:(NSUInteger) routingOptions

Initializes a NMARoutingMode instance with the specified routing parameters.

Parameters:

Returns:

The NMARoutingMode object, or nil if initialization failed