HERE iOS SDK Developer's Guide

NMATollCostOptions

Class Summary

class NMATollCostOptions

Derived from: NSObject

.

Include: NMAKit.framework/headers/NMATollCostOptions.h

Inheritance Diagrams

Figure 1. Public inheritance diagram for NMATollCostOptions

[For complete information, see the section Class Details]

Public Property Summary

Table 1. Public Properties
Public Properties

[readable, writable, strong] NSString *  currency

Currency parameter in the ISO-4217 code format like "EUR" or "USD"

[readable, writable, strong] NSDate *  departure

The departure date for the trip

[readable, strong] NMATollCostVehicleProfile vehicleProfile

The vehicle profile in use

Instance Method Summary

Table 2. Instance Methods
Instance Method Summary

-(nonnull instancetype) init

Creates a toll cost request with the default vehicle profile

-(nullable instancetype) initWithVehicleProfile:(nonnull NMATollCostVehicleProfile *) vehicleProfile

Creates a toll cost request with the specified vehicle profile

Class Details

All the TCE options

Public Property Details

[readable, writable, strong] NSString * currency

Currency parameter in the ISO-4217 code format like "EUR" or "USD". When the currency is found to be invalid, the related request raises an error, either "Currency is not valid" or "Error validating currency: Unknown currency". When it is not set, the default currency "EUR" is used.

See also:

ISO 4217 code

[readable, writable, strong] NSDate * departure

The departure date for the trip.

This is an optional parameter. When it is nil, it is ignored.

See also:

initWithRoute:

[readable, strong] NMATollCostVehicleProfilevehicleProfile

The vehicle profile in use.

Instance Method Details

-(nonnull instancetype) init

Creates a toll cost request with the default vehicle profile.

Returns:

An NMATollCostOptions object configured with the default NMATollCostVehicleProfile.

-(nullable instancetype) initWithVehicleProfile:(nonnull NMATollCostVehicleProfile *) vehicleProfile

Creates a toll cost request with the specified vehicle profile.

Parameters:

  • vehicleProfile

    All the parameters for the toll cost request. When it is nil, the object isn't created, i.e. nil is returned.

Returns:

If the parameters are valid, an NMATollCostOptions object configured with the vehicle profile and nil otherwise.