SYRoutingOptions Class Reference

Class representing complex options available to route calculation. More...

#import <SYRoutingOptions.h>

Inheritance diagram for SYRoutingOptions:

Collaboration diagram for SYRoutingOptions:

Instance Methods
(Sygic::Router::RouteComputeMode::Ptr)	- generateSdkRoutingMode
(instancetype)	- initWithSdkRoutingMode:
(void)	- fillGlobalSdkAvoids:toMode:
(void)	- fillCountrySdkAvoids:forCountry:toMode:

Class Methods
(SYAvoidType)	+ sdkOptionToAvoid:
(NSString *)	+ routingTypeToString:
(NSString *)	+ transportModeToString:
(SYTransportMode)	+ fromSdkTransportMode:

Properties
SYRoutingType	routingType
	Routing type for SYRoutingOptions. Default value is SYRoutingTypeFastest. More...
SYTransportMode	transportMode
	Transport mode for SYRoutingOptions. Default value is SYTransportModeCar. More...
SYVehicleFuelType	fuel
SYEuropeanEmissionStandard	emission
NSUInteger	vehicleYear
NSSet< NSNumber * > *	globalAvoids
	SYAvoidType values stored as [NSNumber numberWithInteger:] for global routing avoids. Default value is SYAvoidTypeNone. More...
NSDictionary< SYCountryIso *, NSSet< NSNumber * > * > *	countryAvoids
	Dictionary of country avoids (SYAvoidType values stored as [NSNumber numberWithInteger:]) per country. More...
NSDate *	departureTime
	The desired departure time. Set to nil to use current time. More...
BOOL	computeAlternativeRoutes
	Option to enable/disable alternative route calculation. Default value is YES. More...
BOOL	suppressDetours
	Allows us to suppress unnecessary detours on temporary closed roads when waiting for road to open is shorter than potential detour. Default value is NO. More...
NSSet< SYRoadElement * > *	avoidRoadElements
	Set to avoid specific road elements. More...
NSSet< SYTrafficEvent * > *	avoidTrafficElements
	Set to avoid some traffic events. More...

Detailed Description

Class representing complex options available to route calculation.

Method Documentation

fillCountrySdkAvoids:forCountry:toMode:()

- (void) fillCountrySdkAvoids:		(NSSet< NSNumber * > *)	avoids
forCountry:		(const std::string &)	country
toMode:		(Sygic::Router::RouteComputeMode::Ptr)	mode

Provided by category SYRoutingOptions(SDK).

fillGlobalSdkAvoids:toMode:()

- (void) fillGlobalSdkAvoids:		(NSSet< NSNumber * > *)	avoids
toMode:		(Sygic::Router::RouteComputeMode::Ptr)	mode

Provided by category SYRoutingOptions(SDK).

fromSdkTransportMode:()

+ (SYTransportMode) fromSdkTransportMode:

(Sygic::Router::ETransportMode)

mode

Provided by category SYRoutingOptions(SDK).

generateSdkRoutingMode()

- Router:

Provided by category SYRoutingOptions(SDK).

initWithSdkRoutingMode:()

- (instancetype) initWithSdkRoutingMode:

(Sygic::Router::RouteComputeMode::Ptr)

mode

Provided by category SYRoutingOptions(SDK).

routingTypeToString:()

+ (NSString*) routingTypeToString:

(SYRoutingType)

routingType

Provided by category SYRoutingOptions(SDK).

sdkOptionToAvoid:()

+ (SYAvoidType) sdkOptionToAvoid:

(Sygic::Router::ERoutingOption)

option

Provided by category SYRoutingOptions(SDK).

transportModeToString:()

+ (NSString*) transportModeToString:

(SYTransportMode)

transportMode

Provided by category SYRoutingOptions(SDK).

Property Documentation

avoidRoadElements

- (NSSet<SYRoadElement*>*) avoidRoadElements

readwritenonatomicstrong

Set to avoid specific road elements.

avoidTrafficElements

- (NSSet<SYTrafficEvent*>*) avoidTrafficElements

readwritenonatomicstrong

Set to avoid some traffic events.

computeAlternativeRoutes

- (BOOL) computeAlternativeRoutes

readwritenonatomicassign

Option to enable/disable alternative route calculation. Default value is YES.

countryAvoids

- (NSDictionary<SYCountryIso*,NSSet<NSNumber*>*>*) countryAvoids

readwritenonatomicstrong

Dictionary of country avoids (SYAvoidType values stored as [NSNumber numberWithInteger:]) per country.

departureTime

- (NSDate*) departureTime

readwritenonatomicstrong

The desired departure time. Set to nil to use current time.

emission

- (SYEuropeanEmissionStandard) emission

readwritenonatomicassign

European emission standard type. Default value is SYEuropeanEmissionStandardEuro5

fuel

- (SYVehicleFuelType) fuel

readwritenonatomicassign

Vehicle fuel type type. Default value is SYVehicleFuelTypePetrol

globalAvoids

- (NSSet<NSNumber*>*) globalAvoids

readwritenonatomicstrong

SYAvoidType values stored as [NSNumber numberWithInteger:] for global routing avoids. Default value is SYAvoidTypeNone.

routingType

- (SYRoutingType) routingType

readwritenonatomicassign

Routing type for SYRoutingOptions. Default value is SYRoutingTypeFastest.

suppressDetours

- (BOOL) suppressDetours

readwritenonatomicassign

Allows us to suppress unnecessary detours on temporary closed roads when waiting for road to open is shorter than potential detour. Default value is NO.

transportMode

- (SYTransportMode) transportMode

readwritenonatomicassign

Transport mode for SYRoutingOptions. Default value is SYTransportModeCar.

vehicleYear

- (NSUInteger) vehicleYear

readwritenonatomicassign

Vehicle manufacturing year used to correctly evaluate emission zones Default value is 2017

---

The documentation for this class was generated from the following file:

• SYRoutingOptions.h