RoutingOptions class
The options defines how a route should be calculated.
The options are used for all transport modes and engines.
** Electric vehicle specific requirements ** Electric vehicle consumption are estimated when at least one consumption model is defined. Currently two models are supported:
- PhysicalConsumptionModel
Aside from the values in PhysicalConsumptionModel additionally these values needs to be defined:
- VehicleSpecification.currentWeightInKilograms from TransportSpecification.vehicleSpecification from RoutingOptions.transportSpecification
- Additionally Waypoint.currentWeightChangeInKilograms can be defined.
- EmpiricalConsumptionModel
By setting ElectricVehicleOptions.ensureReachability the RoutingEngine inserts additional charging stations
to reach the waypoints.
This feature requires setting the BatterySpecifications.
By default a vehicle might not reach the waypoint, when the initial charge is not enough to reach all waypoints.
See the parameter description below for more details.
Constructors
Properties
- allowOptions ↔ AllowOptions
-
The options explicitly allowed by user for route calculations.
By default no options are opt in.
getter/setter pair
- avoidanceOptions ↔ AvoidanceOptions
-
Options to specify restrictions for route calculations.
By default no restrictions are applied.
getter/setter pair
- evOptions ↔ ElectricVehicleOptions?
-
Defines the electric vehicle (EV) related parameters to calculate the consumption and reachability.
When no EV options are defined an internal combustion engine is assumed.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setter
-
maxSpeedOnSegments
↔ List<
MaxSpeedOnSegment> -
Segments with restriction on maximum DynamicSpeedInfo.baseSpeedInMetersPerSecond.
Note Not used for offline calculations.
getter/setter pair
- routeOptions ↔ RouteOptions
-
Specifies the common route calculation options.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- textOptions ↔ RouteTextOptions
-
Customize textual content returned from the route calculation, such
as localization, format, and unit system.
getter/setter pair
- tollOptions ↔ TollOptions
-
Options to specify how the tolls should be calculated,
such as transponders, vehicle category, and emission type.
Note Not used for offline calculations.
getter/setter pair
- transportSpecification ↔ TransportSpecification
-
Defines the transport specification which contains the transport mode and the vehicle specifications
for the transport mode chosen.
Notes:
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool - The equality operator.
Static Methods
-
fromDefaultParameterConfiguration(
) → RoutingOptions - Returns the default configuration for the transport specification selected in ParameterConfiguration.transportSpecification from SDKNativeEngine.parameterConfig.