problem_defaults

The problem_defaults object contains default values that are used by the optimizer for various cases where an explicit value is not provided on the route, driver, or vehicle.

Name Type Description
allow_ferries boolean If enabled, the driver can utilize ferries. Defaults to a value based on the vehicle_type. Can be overridden by vehicle.allow_ferries or route.allow_ferries. Requires Advanced Optimizer Settings.
allow_toll_roads boolean If enabled, the driver can make use of toll roads. Defaults to a value based on the vehicle_type. Can be overridden by vehicle.allow_toll_roads or route.allow_toll_roads). Requires Advanced Optimizer Settings.
allow_u_turns boolean If enabled, the driver can make u-turns. This is disabled if same_side_routing is enabled. Defaults to a value based on the vehicle_type. Can be overridden by vehicle.allow_u_turns or route.allow_u_turns. Requires Advanced Optimizer Settings.
cost_per_hour float The number of US$ per hour worked. Can be overridden by either route.cost_per_hour or driver.cost_per_hour. Defaults to $10.
driving_speed_percentage float Percentage of the expected speed that routes will be driven at by default. This is useful for taking into account heavy traffic. Stacks with vehicle.driving_speed_percentage; for example, if a route and its vehicle both have a driving speed percentage of 50, the overall speed for the route is reduced to 25%. Can be overridden by route.driving_speed_percentage. Defaults to 100.
enable_end_stem_time boolean Defines if the optimization includes the effect of the time it takes to drive from the last job on a route to the depot. Can be overridden by route.enable_end_stem_time. Defaults to true.
enable_start_stem_time boolean Defines if the optimization includes the effect of the time it takes to drive to the first job on a route. Can be overridden by route.enable_start_stem_time. Defaults to true.
end_time timespan If using optimize_start_time, set this field to determine the latest time that the route can end. Can be overridden by route.end_time. See Routing with Shifts.
hazmat_load_type hazmat_load_type A comma-separated list of the types of hazardous material carried by this vehicle. Affects access to certain roads. Defaults to no hazmat loads. Can be overridden by vehicle.hazmat_load_type or route.hazmat_load_type. Requires Advanced Optimizer Settings.
height_cm float The height of the vehicle, in centimeters. Affects access to certain roads. Defaults to a value based on the vehicle_type. Can be overridden by vehicle.height_cm or route.height_cm. Requires Advanced Optimizer Settings.
kingpin_to_axle_cm float The kingpin is the point at which the trailer in a tractor-trailer pair attaches to the tractor. This length represents the longest straight line of the vehicle. It gives an indication of the manuverablity of the vehicle and affects access to certain roads. Defaults to a value based on the vehicle_type. Can be overridden by vehicle.kingpin_to_axle_cm or route.kingpin_to_axle_cm. Requires Advanced Optimizer Settings.
length_cm float The length of the vehicle, in centimeters. Affects access to certain roads. Defaults to a value based on the vehicle_type. Can be overridden by vehicle.length_cm or route.length_cm. Requires Advanced Optimizer Settings.
max_multiday_days integer The maximum length (in days) of a multi-day route for drivers. Can be overridden by driver.max_multiday_days. Defaults to 1 (no multi-day routes). See Routing with Multi-day Routes.
max_working_time timespan The maximum total time of the route. Can be overridden by route.max_working_time. See Routing with Shifts.
normal_working_time timespan The total time on route before overtime rates must be paid. Can be overridden by route.normal_working_time. See Routing with Shifts.
number_of_axles integer The number of axles. This setting allows vehicles with more axles to carry more weight on some weight-restricted roads. Defaults to a value based on the vehicle_type. Can be overridden by vehicle.number_of_axles or route.number_of_axles. Requires Advanced Optimizer Settings.
number_of_trailers integer The number of trailers. Used to avoid roads with legal restrictions on vehicles with items in tow. Defaults to a value based on the vehicle_type. Can be overridden by vehicle.number_of_trailers or route.number_of_trailers. Requires Advanced Optimizer Settings.
number_of_wheels integer The number of wheels. This setting allows vehicles with more wheels to carry more weight on some weight-restricted roads. Defaults to a value based on the vehicle_type. Can be overridden by vehicle.number_of_wheels or route.number_of_wheels. Requires Advanced Optimizer Settings.
optimize_start_time boolean Allows routes to start after their start_time if it is efficient to do so. Can be overridden by route.optimize_start_time. Defaults to false. See Routing with Shifts.
overtime_cost_per_hour float The number of US$ per overtime hour worked. Overtime hours occur when a route's duration exceeds normal_working_time. Can be overridden by either route.cost_per_hour or driver.cost_per_hour. Defaults to the value of 1.5 × cost_per_hour.
same_side_routing boolean If enabled, the driver must stop on the same side of the road as the job they are delivering to. Defaults to a value based on the vehicle_type. Can be overridden by vehicle.same_side_routing or route.same_side_routing). Requires Advanced Optimizer Settings.
start_time timespan The time of day that the driver starts at the start location. Can be overridden by route.start_time. See Routing with Shifts.
time_on_site_at_end_location timespan The amount of time spent at the end location (for example, for unloading the vehicle). Can be overridden by route.time_on_site_at_end_location.
time_on_site_at_return_to_depot timespan The amount of time spent at a return-to-depot (for example, for loading or unloading the vehicle). Can be overridden by vehicle.time_on_site_at_return_to_depot, or, if not using vehicles, can be overridden by route.time_on_site_at_return_to_depot. See Routing with Capacities.
time_on_site_at_start_location timespan The amount of time spent at the start location (for example, for loading the vehicle). Can be overridden by route.time_on_site_at_start_location.
unladen_weight_kg float The weight of the vehicle in kilograms when not carrying any load. Affects access to certain roads. Defaults to a value based on the vehicle_type. Can be overridden by vehicle.unladen_weight_kg or route.unladen_weight_kg. Requires Advanced Optimizer Settings.
vehicle_type string The type of vehicle. Can be set to the following: car, truck, auto, straight_truck, standard_single_truck, standard_double_truck, intermediate_double_truck, long_double_truck, or standard_triple_truck. The vehicle type affects access to certain roads. Defaults to Auto. Can be overridden by vehicle.vehicle_type or route.vehicle_type. Requires Advanced Optimizer Settings.
weight_kg float The weight of the vehicle, in kilograms. Affects access to certain roads. Defaults to a value based on the vehicle_type. Can be overridden by vehicle.weight_kg or route.weight_kg. Requires Advanced Optimizer Settings.
width_cm float The width of the vehicle, in centimeters. Affects access to certain roads. Defaults to a value based on the vehicle_type. Can be overridden by vehicle.width_cm or route.width_cm. Requires Advanced Optimizer Settings.

Example

{
	"cost_per_hour": 26.00,
	"overtime_cost_per_hour": 30.00
}

See Also