Class representing complex options available to route calculation.
More...
#import <SYRoutingOptions.h>
|
| SYRoutingType | routingType |
| | Routing type for SYRoutingOptions. Default value is SYRoutingTypeFastest. 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...
|
| |
| 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...
|
| |
| BOOL | arriveInDrivingSide |
| | Option which indicates whether routing should finish on endpoint's side of road. 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...
|
| |
| NSArray< SYWaypoint * > * | avoidWaypoints |
| | Array of waypoints which have to be avoided. Typical scenario of usage: during computing a route for electric vehicle some charging waypoints are automatically added, but the user doesn't like some of them, then those unwanted waypoint should be added to this property for the next route compute. 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...
|
| |
| SYVehicleProfile * | vehicleProfile |
| | Vehicle which is used for navigation or nil if navigating as a pedestrian. Contains all available information about a vehicle for which the route is computed. Default value is default vehicle profile (makeDefaultProfile (SYVehicleProfile)). More...
|
| |
| BOOL | useTraffic |
| | Option which indicates whether routing is allowed to use traffic information to optimize the path or avoid traffic closures. Default value is YES. More...
|
| |
| BOOL | useAutomaticChargingWaypoints |
| | Option which indicates whether charging waypoints should be added automatically during EV routing. Default value is YES. More...
|
| |
Class representing complex options available to route calculation.
◆ routingType
| - (SYRoutingType) routingType |
|
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.
◆ 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.
◆ arriveInDrivingSide
| - (BOOL) arriveInDrivingSide |
|
readwritenonatomicassign |
Option which indicates whether routing should finish on endpoint's side of road. 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].
◆ avoidWaypoints
Array of waypoints which have to be avoided. Typical scenario of usage: during computing a route for electric vehicle some charging waypoints are automatically added, but the user doesn't like some of them, then those unwanted waypoint should be added to this property for the next route compute.
◆ 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.
◆ vehicleProfile
Vehicle which is used for navigation or nil if navigating as a pedestrian. Contains all available information about a vehicle for which the route is computed. Default value is default vehicle profile (makeDefaultProfile (SYVehicleProfile)).
◆ useTraffic
Option which indicates whether routing is allowed to use traffic information to optimize the path or avoid traffic closures. Default value is YES.
◆ useAutomaticChargingWaypoints
| - (BOOL) useAutomaticChargingWaypoints |
|
readwritenonatomicassign |
Option which indicates whether charging waypoints should be added automatically during EV routing. Default value is YES.
The documentation for this class was generated from the following file:
1.8.17 