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, assign] NSDate *  arrivalTime

The desired arrival time, used for route calculation

[readable, writable, assign] NSUInteger  backward

The number of routes to be returned that are departing/arriving before the given time

[readable, writable, strong] NSDate *  departureTime

The desired departure time

[readable, writable, assign] NSUInteger  forward

The number of routes to be returned that are departing/arriving after the given time

[readable, writable, assign] NMAHazardousGoodsType   hazardousGoods

An OR combination of NMAHazardousGoodsType values that apply to the cargo for the truck route

[readable, writable, assign] float  limitedVehicleWeight

The limited vehicle weight in metric tons

[readable, writable, assign] NSUInteger  maximumChanges

The maximum number of vehicle changes allowed during the trip

[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] float  startDirection

The direction, in degrees, that routing should start in

[readable, writable, assign] BOOL  strict

Specifies if the number of returned connections must be strict, regarding to backward/forward parameters

[readable, writable, assign] BOOL  trafficUsed

Determines whether or not traffic is taken into account when calculating a route

[readable, writable, assign] NSUInteger  trailersCount

Number of the trailers

[readable, writable, assign] NSUInteger  transitRoutingOptions

The OR-ed NMATransitRoutingOption values for the NMARoutingMode

[readable, writable, assign] NMATransportMode   transportMode

The NMATransportMode for the NMARoutingMode

[readable, writable, assign] NMATruckRestrictionsMode   truckRestrictionsMode

Sets truck restrictions handling mode

[readable, writable, assign] NMATruckType   truckType

Truck type of the routed truck

[readable, writable, assign] NMATunnelCategory   tunnelCategory

The tunnel category to which the truck route should be restricted

[readable, writable, assign] NSUInteger  urbanMobilityRoutingOptions

The OR-ed NMAUrbanMobilityOption values for the NMARoutingMode

[readable, writable, assign] NMAUrbanMobilityRoutingTypeOption   urbanMobilityRoutingType

[readable, writable, assign] float  vehicleHeight

The vehicle height in meters

[readable, writable, assign] float  vehicleLength

The vehicle length in meters

[readable, writable, assign] float  vehicleWidth

The vehicle width in meters

[readable, writable, assign] NSUInteger  walkDistance

The maximum walking distance to cover on foot to the nearest station

[readable, writable, assign] NSUInteger  walkSpeed

The walking speed in m/h that the user is having

[readable, writable, assign] float  weightPerAxle

The vehicle weight per axle in metric tons

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, assign] NSDate * arrivalTime

The desired arrival time, used for route calculation. If it's nil, departure time is used for route calculation.

[readable, writable, assign] NSUInteger backward

The number of routes to be returned that are departing/arriving before the given time.

Note:

The maximum is 6, minimum 0, but the sum of backward and forward routes cannot be more than 6.

[readable, writable, strong] NSDate * departureTime

The desired departure time.

[readable, writable, assign] NSUInteger forward

The number of routes to be returned that are departing/arriving after the given time.

Note:

The maximum is 6, minimum 0, but the sum of backward and forward routes cannot be more than 6.

[readable, writable, assign] NMAHazardousGoodsType  hazardousGoods

An OR combination of NMAHazardousGoodsType values that apply to the cargo for the truck route.

Note:

The default value is 0 (no hazardous goods).

Note:

Truck routing only.

[readable, writable, assign] float limitedVehicleWeight

The limited vehicle weight in metric tons.

Note:

The default value is 0 (no vehicle weight limit).

Note:

Truck routing only.

[readable, writable, assign] NSUInteger maximumChanges

The maximum number of vehicle changes allowed during the trip.

[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] float startDirection

The direction, in degrees, that routing should start in. Use values in range 0..359. If a value greater than 359 is specified, the modulus of 360 is used. Values will be rounded to the nearest integral value.

Defaults to NMARoutingModeStartDirectionAny which means route in any direction in order to obtain the shortest/fastest possible route.

/note To route in the current direction of travel set this property to [ NMAPositioningManager sharedPositioningManager].currentPosition.course

[readable, writable, assign] BOOL strict

Specifies if the number of returned connections must be strict, regarding to backward/forward parameters. YES if true, NO otherwise.

[readable, writable, assign] BOOL trafficUsed

Determines whether or not traffic is taken into account when calculating a route.

Note:

Traffic-based routing requires an internet connection.

[readable, writable, assign] NSUInteger trailersCount

Number of the trailers.

Note:

The default value is 0 (unspecified).

Note:

Truck routing only.

[readable, writable, assign] NSUInteger transitRoutingOptions

The OR-ed NMATransitRoutingOption values for the NMARoutingMode.

Note:

The default value is 0 (no options selected).

[readable, writable, assign] NMATransportMode  transportMode

The NMATransportMode for the NMARoutingMode.

Note:

The default value is NMATransportModeCar.

[readable, writable, assign] NMATruckRestrictionsMode  truckRestrictionsMode

Sets truck restrictions handling mode. If no mode is explicitly set then NMATruckRestrictionsNoViolations option will be used.

[readable, writable, assign] NMATruckType  truckType

Truck type of the routed truck.

Note:

The default value is 0 (unspecified).

Note:

Truck routing only.

[readable, writable, assign] NMATunnelCategory  tunnelCategory

The tunnel category to which the truck route should be restricted.

Note:

The default value is NMATunnelCategoryNone.

Note:

Truck routing only.

[readable, writable, assign] NSUInteger urbanMobilityRoutingOptions

The OR-ed NMAUrbanMobilityOption values for the NMARoutingMode.

Note:

The default value is 0 (no options selected).

[readable, writable, assign] NMAUrbanMobilityRoutingTypeOption  urbanMobilityRoutingType

[readable, writable, assign] float vehicleHeight

The vehicle height in meters.

Note:

The default value is 0 (unspecified).

Note:

Truck routing only.

[readable, writable, assign] float vehicleLength

The vehicle length in meters.

Note:

The default value is 0 (unspecified).

Note:

Truck routing only.

[readable, writable, assign] float vehicleWidth

The vehicle width in meters.

Note:

The default value is 0 (unspecified).

Note:

Truck routing only.

[readable, writable, assign] NSUInteger walkDistance

The maximum walking distance to cover on foot to the nearest station.

[readable, writable, assign] NSUInteger walkSpeed

The walking speed in m/h that the user is having.

[readable, writable, assign] float weightPerAxle

The vehicle weight per axle in metric tons.

Note:

The default value is 0 (unspecified).

Note:

Truck routing only.

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

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.