Class representing complex options available to route calculation.
More...
#import <SYRoutingOptions.h>
|
| 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 SYAvoidTypeUnpavedRoads. 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 | useEndpointProtection |
| | Option which indicates whether routing is allowed to break restrictions in vicinity of start, via or end point if no restriction-free route exists. Sometimes it is necessary to ignore some restriction in order to reach endpoint. Default value is YES. 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...
|
| |
| SYTurnPreference | turnPreference |
| | Specifies which turns the routing algorithm should prefer. Default value is SYTurnPreferenceAdjacentRoadTurn. More...
|
| |
| SYPreferredRoad | preferredRoad |
| | Specifies which road should be preffered for various Truck Combinations/Truck Trains. Default value is SYPreferredRoadNone. More...
|
| |
| NSURL * | urlOverride |
| | Override of default online routing URL. More...
|
| |
| SYDimensionalRestrictionOptions * | dimensionalOptions |
| | Vehicle parameters related to size and weight. Default value is nil. More...
|
| |
| SYHazmatSettings * | hazmatSettings |
| | Settings related to hazardous material cargo. Default value is nil. More...
|
| |
| SYConsumptionCurve * | consumptionCurve |
| | Settings related to consumption based on speed. Default value is nil. More...
|
| |
Class representing complex options available to route calculation.
◆ routingType
| - (SYRoutingType) routingType |
|
readwritenonatomicassign |
◆ transportMode
| - (SYTransportMode) transportMode |
|
readwritenonatomicassign |
◆ 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 SYAvoidTypeUnpavedRoads.
◆ 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.
◆ useEndpointProtection
| - (BOOL) useEndpointProtection |
|
readwritenonatomicassign |
Option which indicates whether routing is allowed to break restrictions in vicinity of start, via or end point if no restriction-free route exists. Sometimes it is necessary to ignore some restriction in order to reach endpoint. Default value is YES.
◆ avoidTrafficElements
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
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.
◆ turnPreference
| - (SYTurnPreference) turnPreference |
|
readwritenonatomicassign |
Specifies which turns the routing algorithm should prefer. Default value is SYTurnPreferenceAdjacentRoadTurn.
◆ preferredRoad
| - (SYPreferredRoad) preferredRoad |
|
readwritenonatomicassign |
Specifies which road should be preffered for various Truck Combinations/Truck Trains. Default value is SYPreferredRoadNone.
◆ urlOverride
Override of default online routing URL.
◆ dimensionalOptions
Vehicle parameters related to size and weight. Default value is nil.
◆ hazmatSettings
Settings related to hazardous material cargo. Default value is nil.
◆ consumptionCurve
Settings related to consumption based on speed. Default value is nil.
The documentation for this class was generated from the following file: