SYRoutingOptions Class Reference

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

#import <SYRoutingOptions.h>

Inheritance diagram for SYRoutingOptions:
Collaboration diagram for SYRoutingOptions:

Properties

SYRoutingType routingType
 Routing type for SYRoutingOptions. Default value is SYRoutingTypeFastest. More...
 
SYTransportMode transportMode
 Transport mode for SYRoutingOptions. Default value is SYTransportModeCar. More...
 
SYNearestAccessiblePointStrategyType napStrategyType
 Nearest accessible point (NAP) strategy. Default value is SYNearestAccessiblePointStrategyTypeDisabled. More...
 
SYRoutingService routingService
 Defines the preferred processing unit to compute the route. Default value is SYRoutingServiceAutomatic. 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...
 
NSArray< SYGeoPolyline * > * avoidPolylines
 Array of geographical polylines which have to be avoided. See also [SYRoute getPolylinesFromRouteSegments]. More...
 
NSUInteger maxSpeed
 The maximum speed of vehicle. Default and maximum allowed value is 255, if higher value set, default is used. Value 0 means no maximum speed limit. More...
 

Detailed Description

Class representing complex options available to route calculation.

Property Documentation

◆ routingType

- (SYRoutingType) routingType
readwritenonatomicassign

Routing type for SYRoutingOptions. Default value is SYRoutingTypeFastest.

◆ transportMode

- (SYTransportMode) transportMode
readwritenonatomicassign

Transport mode for SYRoutingOptions. Default value is SYTransportModeCar.

◆ napStrategyType

- (SYNearestAccessiblePointStrategyType) napStrategyType
readwritenonatomicassign

Nearest accessible point (NAP) strategy. Default value is SYNearestAccessiblePointStrategyTypeDisabled.

◆ routingService

- (SYRoutingService) routingService
readwritenonatomicassign

Defines the preferred processing unit to compute the route. Default value is SYRoutingServiceAutomatic.

◆ fuel

- (SYVehicleFuelType) fuel
readwritenonatomicassign

Vehicle fuel type type. Default value is SYVehicleFuelTypePetrol

◆ emission

- (SYEuropeanEmissionStandard) emission
readwritenonatomicassign

European emission standard type. Default value is SYEuropeanEmissionStandardEuro5

◆ vehicleYear

- (NSUInteger) vehicleYear
readwritenonatomicassign

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

◆ globalAvoids

- (NSSet<NSNumber*>*) globalAvoids
readwritenonatomicstrong

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

◆ 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.

◆ computeAlternativeRoutes

- (BOOL) computeAlternativeRoutes
readwritenonatomicassign

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

◆ 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.

◆ avoidRoadElements

- (NSSet<SYRoadElement*>*) avoidRoadElements
readwritenonatomicstrong

Set to avoid specific road elements.

◆ avoidTrafficElements

- (NSSet<SYTrafficEvent*>*) avoidTrafficElements
readwritenonatomicstrong

Set to avoid some traffic events.

◆ avoidPolylines

- (NSArray<SYGeoPolyline*>*) avoidPolylines
readwritenonatomicstrong

Array of geographical polylines which have to be avoided. See also [SYRoute getPolylinesFromRouteSegments].

◆ maxSpeed

- (NSUInteger) maxSpeed
readwritenonatomicassign

The maximum speed of vehicle. Default and maximum allowed value is 255, if higher value set, default is used. Value 0 means no maximum speed limit.


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