Skip to content

WaypointOptimizationDriverOptions

Used by
Source code in docs_src/capo_geo_routes/types/waypoint_optimization_driver_options.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
class WaypointOptimizationDriverOptions(TypedDict, closed=True):
    rest_cycles: NotRequired[
        "capo_geo_routes.types.waypoint_optimization_rest_cycles.WaypointOptimizationRestCycles"
    ]
    """<p>Driver work-rest schedules defined by a short and long cycle. A rest needs to be taken after the short work duration. The short cycle can be repeated until you hit the long work duration, at which point the long rest duration should be taken before restarting.</p>"""
    rest_profile: NotRequired[
        "capo_geo_routes.types.waypoint_optimization_rest_profile.WaypointOptimizationRestProfile"
    ]
    """<p>Pre defined rest profiles for a driver schedule. The only currently supported profile is EU.</p>"""
    treat_service_time_as: NotRequired[
        "capo_geo_routes.types.waypoint_optimization_service_time_treatment.WaypointOptimizationServiceTimeTreatment"
    ]
    """<p>If the service time provided at a waypoint/destination should be considered as rest or work. This contributes to the total time breakdown returned within the response.</p>"""

rest_cycles instance-attribute 

rest_cycles: NotRequired[WaypointOptimizationRestCycles]

Driver work-rest schedules defined by a short and long cycle. A rest needs to be taken after the short work duration. The short cycle can be repeated until you hit the long work duration, at which point the long rest duration should be taken before restarting.

rest_profile instance-attribute 

rest_profile: NotRequired[WaypointOptimizationRestProfile]

Pre defined rest profiles for a driver schedule. The only currently supported profile is EU.

treat_service_time_as instance-attribute 

treat_service_time_as: NotRequired[WaypointOptimizationServiceTimeTreatment]

If the service time provided at a waypoint/destination should be considered as rest or work. This contributes to the total time breakdown returned within the response.