Skip to content

CalculateRouteTruckModeOptions

Used by
Source code in docs_src/capo_location/types/calculate_route_truck_mode_options.py 
13
14
15
16
17
18
19
20
21
class CalculateRouteTruckModeOptions(TypedDict, closed=True):
    avoid_ferries: NotRequired["capo_location.types.sensitive_boolean.SensitiveBoolean"]
    """<p>Avoids ferries when calculating routes.</p> <p>Default Value: <code>false</code> </p> <p>Valid Values: <code>false</code> | <code>true</code> </p>"""
    avoid_tolls: NotRequired["capo_location.types.sensitive_boolean.SensitiveBoolean"]
    """<p>Avoids tolls when calculating routes.</p> <p>Default Value: <code>false</code> </p> <p>Valid Values: <code>false</code> | <code>true</code> </p>"""
    dimensions: NotRequired["capo_location.types.truck_dimensions.TruckDimensions"]
    """<p>Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.</p>"""
    weight: NotRequired["capo_location.types.truck_weight.TruckWeight"]
    """<p>Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.</p>"""

avoid_ferries instance-attribute 

avoid_ferries: NotRequired[SensitiveBoolean]

Avoids ferries when calculating routes.

Default Value: false

Valid Values: false | true

avoid_tolls instance-attribute 

avoid_tolls: NotRequired[SensitiveBoolean]

Avoids tolls when calculating routes.

Default Value: false

Valid Values: false | true

dimensions instance-attribute 

dimensions: NotRequired[TruckDimensions]

Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.

weight instance-attribute 

weight: NotRequired[TruckWeight]

Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.