Skip to content

RouteMatrixTruckOptions

Source code in docs_src/capo_geo_routes/types/route_matrix_truck_options.py
class RouteMatrixTruckOptions(TypedDict, closed=True):
    axle_count: NotRequired["capo_geo_routes.types.sensitive_integer.SensitiveInteger"]
    """<p>Total number of axles of the vehicle.</p>"""
    gross_weight: "capo_geo_routes.types.weight_kilograms.WeightKilograms"
    """<p>Gross weight of the vehicle including trailers, and goods at capacity.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>"""
    hazardous_cargos: NotRequired[
        "capo_geo_routes.types.route_matrix_hazardous_cargo_type_list.RouteMatrixHazardousCargoTypeList"
    ]
    """<p>List of Hazardous cargo contained in the vehicle.</p>"""
    height: "capo_geo_routes.types.dimension_centimeters.DimensionCentimeters"
    """<p>Height of the vehicle.</p> <p> <b>Unit</b>: <code>centimeters</code> </p>"""
    kpra_length: "capo_geo_routes.types.dimension_centimeters.DimensionCentimeters"
    """<p>Kingpin to rear axle length of the vehicle</p> <p> <b>Unit</b>: <code>centimeters</code> </p>"""
    length: "capo_geo_routes.types.dimension_centimeters.DimensionCentimeters"
    """<p>Length of the vehicle.</p> <p> <b>Unit</b>: <code>centimeters</code> </p>"""
    license_plate: NotRequired[
        "capo_geo_routes.types.route_matrix_vehicle_license_plate.RouteMatrixVehicleLicensePlate"
    ]
    """<p>The vehicle License Plate.</p>"""
    max_speed: NotRequired[
        "capo_geo_routes.types.speed_kilometers_per_hour.SpeedKilometersPerHour"
    ]
    """<p>Maximum speed</p> <p> <b>Unit</b>: <code>kilometers per hour</code> </p>"""
    occupancy: NotRequired["capo_geo_routes.types.sensitive_integer.SensitiveInteger"]
    """<p>The number of occupants in the vehicle.</p> <p>Default value: <code>1</code> </p>"""
    payload_capacity: "capo_geo_routes.types.weight_kilograms.WeightKilograms"
    """<p>Payload capacity of the vehicle and trailers attached.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>"""
    trailer: NotRequired[
        "capo_geo_routes.types.route_matrix_trailer_options.RouteMatrixTrailerOptions"
    ]
    """<p>Trailer options corresponding to the vehicle.</p>"""
    truck_type: NotRequired[
        "capo_geo_routes.types.route_matrix_truck_type.RouteMatrixTruckType"
    ]
    """<p>The type of truck: <code>LightTruck</code> for smaller delivery vehicles, <code> StraightTruck</code> for rigid body trucks, or <code>Tractor</code> for tractor-trailer combinations.</p>"""
    tunnel_restriction_code: NotRequired[
        "capo_geo_routes.types.tunnel_restriction_code.TunnelRestrictionCode"
    ]
    """<p>The tunnel restriction code.</p> <p>Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.</p> <ul> <li> <p> <i>Tunnel Category B</i> </p> <ul> <li> <p> <i>Risk Level</i>: Limited risk</p> </li> <li> <p> <i>Restrictions</i>: Few restrictions</p> </li> </ul> </li> <li> <p> <i>Tunnel Category C</i> </p> <ul> <li> <p> <i>Risk Level</i>: Medium risk</p> </li> <li> <p> <i>Restrictions</i>: Some restrictions</p> </li> </ul> </li> <li> <p> <i>Tunnel Category D</i> </p> <ul> <li> <p> <i>Risk Level</i>: High risk</p> </li> <li> <p> <i>Restrictions</i>: Many restrictions occur</p> </li> </ul> </li> <li> <p> <i>Tunnel Category E</i> </p> <ul> <li> <p> <i>Risk Level</i>: Very high risk</p> </li> <li> <p> <i>Restrictions</i>: Restricted tunnel</p> </li> </ul> </li> </ul>"""
    weight_per_axle: "capo_geo_routes.types.weight_kilograms.WeightKilograms"
    """<p>Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>"""
    weight_per_axle_group: NotRequired[
        "capo_geo_routes.types.weight_per_axle_group.WeightPerAxleGroup"
    ]
    """<p>Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.</p>"""
    width: "capo_geo_routes.types.dimension_centimeters.DimensionCentimeters"
    """<p>Width of the vehicle.</p> <p> <b>Unit</b>: <code>centimeters</code> </p>"""

axle_count instance-attribute

axle_count: NotRequired[SensitiveInteger]

Total number of axles of the vehicle.

gross_weight instance-attribute

gross_weight: WeightKilograms

Gross weight of the vehicle including trailers, and goods at capacity.

Unit: kilograms

hazardous_cargos instance-attribute

hazardous_cargos: NotRequired[RouteMatrixHazardousCargoTypeList]

List of Hazardous cargo contained in the vehicle.

height instance-attribute

Height of the vehicle.

Unit: centimeters

kpra_length instance-attribute

kpra_length: DimensionCentimeters

Kingpin to rear axle length of the vehicle

Unit: centimeters

length instance-attribute

Length of the vehicle.

Unit: centimeters

license_plate instance-attribute

license_plate: NotRequired[RouteMatrixVehicleLicensePlate]

The vehicle License Plate.

max_speed instance-attribute

max_speed: NotRequired[SpeedKilometersPerHour]

Maximum speed

Unit: kilometers per hour

occupancy instance-attribute

occupancy: NotRequired[SensitiveInteger]

The number of occupants in the vehicle.

Default value: 1

payload_capacity instance-attribute

payload_capacity: WeightKilograms

Payload capacity of the vehicle and trailers attached.

Unit: kilograms

trailer instance-attribute

trailer: NotRequired[RouteMatrixTrailerOptions]

Trailer options corresponding to the vehicle.

truck_type instance-attribute

truck_type: NotRequired[RouteMatrixTruckType]

The type of truck: LightTruck for smaller delivery vehicles, StraightTruck for rigid body trucks, or Tractor for tractor-trailer combinations.

tunnel_restriction_code instance-attribute

tunnel_restriction_code: NotRequired[TunnelRestrictionCode]

The tunnel restriction code.

Tunnel categories in this list indicate the restrictions which apply to certain tunnels in Great Britain. They relate to the types of dangerous goods that can be transported through them.

  • Tunnel Category B

    • Risk Level: Limited risk

    • Restrictions: Few restrictions

  • Tunnel Category C

    • Risk Level: Medium risk

    • Restrictions: Some restrictions

  • Tunnel Category D

    • Risk Level: High risk

    • Restrictions: Many restrictions occur

  • Tunnel Category E

    • Risk Level: Very high risk

    • Restrictions: Restricted tunnel

weight_per_axle instance-attribute

weight_per_axle: WeightKilograms

Heaviest weight per axle irrespective of the axle type or the axle group. Meant for usage in countries where the differences in axle types or axle groups are not distinguished.

Unit: kilograms

weight_per_axle_group instance-attribute

weight_per_axle_group: NotRequired[WeightPerAxleGroup]

Specifies the total weight for the specified axle group. Meant for usage in countries that have different regulations based on the axle group type.

width instance-attribute

Width of the vehicle.

Unit: centimeters