Skip to content

IsolineTruckOptions

Source code in docs_src/capo_geo_routes/types/isoline_truck_options.py
class IsolineTruckOptions(TypedDict, closed=True):
    axle_count: NotRequired["capo_geo_routes.types.sensitive_integer.SensitiveInteger"]
    """<p>The total number of axles on the vehicle. Required for certain road restrictions and weight limit calculations.</p>"""
    engine_type: NotRequired[
        "capo_geo_routes.types.isoline_engine_type.IsolineEngineType"
    ]
    """<p>The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.</p> <ul> <li> <p> <code>INTERNAL_COMBUSTION</code>—Standard gasoline or diesel engine.</p> </li> <li> <p> <code>ELECTRIC</code>—Battery electric vehicle.</p> </li> <li> <p> <code>PLUGIN_HYBRID</code>—Combination of electric and internal combustion engines with plug-in charging capability.</p> </li> </ul>"""
    gross_weight: "capo_geo_routes.types.weight_kilograms.WeightKilograms"
    """<p>The gross vehicle weight (the maximum weight a vehicle can safely operate at, as specified by the manufacturer) in kilograms. Used to avoid roads with weight restrictions and ensure compliance with maximum allowed vehicle weight regulations.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>"""
    hazardous_cargos: NotRequired[
        "capo_geo_routes.types.isoline_hazardous_cargo_type_list.IsolineHazardousCargoTypeList"
    ]
    """<p>Types of hazardous materials being transported. This affects which roads and tunnels can be used based on local regulations.</p> <ul> <li> <p> <code>Combustible</code>—Materials that can burn readily</p> </li> <li> <p> <code>Corrosive</code>—Materials that can destroy or irreversibly damage other substances</p> </li> <li> <p> <code>Explosive</code>—Materials that can produce an explosion by chemical reaction</p> </li> <li> <p> <code>Flammable</code>—Materials that can easily ignite</p> </li> <li> <p> <code>Gas</code>—Hazardous materials in gaseous form</p> </li> <li> <p> <code>HarmfulToWater</code>—Materials that pose a risk to water sources if released</p> </li> <li> <p> <code>Organic</code>—Hazardous organic compounds</p> </li> <li> <p> <code>Other</code>—Hazardous materials not covered by other categories</p> </li> <li> <p> <code>Poison</code>—Toxic materials</p> </li> <li> <p> <code>PoisonousInhalation</code>—Materials that are toxic when inhaled</p> </li> <li> <p> <code>Radioactive</code>—Materials that emit ionizing radiation</p> </li> </ul>"""
    height: "capo_geo_routes.types.dimension_centimeters.DimensionCentimeters"
    """<p>The vehicle height in centimeters. Used to avoid routes with low bridges or other height restrictions.</p> <p> <b>Unit</b>: <code>centimeters</code> </p>"""
    height_above_first_axle: (
        "capo_geo_routes.types.dimension_centimeters.DimensionCentimeters"
    )
    """<p>The height in centimeters measured from the ground to the highest point above the first axle. Used for specific bridge and tunnel clearance restrictions.</p> <p> <b>Unit</b>: <code>centimeters</code> </p>"""
    kpra_length: "capo_geo_routes.types.dimension_centimeters.DimensionCentimeters"
    """<p>The kingpin to rear axle (KPRA) length in centimeters. Used to determine if the vehicle can safely navigate turns and intersections.</p> <p> <b>Unit</b>: <code>centimeters</code> </p>"""
    length: "capo_geo_routes.types.dimension_centimeters.DimensionCentimeters"
    """<p>The total vehicle length in centimeters. Used to avoid roads with length restrictions and determine if the vehicle can safely navigate turns.</p> <p> <b>Unit</b>: <code>centimeters</code> </p>"""
    license_plate: NotRequired[
        "capo_geo_routes.types.isoline_vehicle_license_plate.IsolineVehicleLicensePlate"
    ]
    """<p>License plate information used in regions where road access or routing restrictions are based on license plate numbers.</p>"""
    max_speed: NotRequired[
        "capo_geo_routes.types.speed_kilometers_per_hour.SpeedKilometersPerHour"
    ]
    """<p>The maximum speed in kilometers per hour at which the vehicle can or is permitted to travel. This affects travel time calculations and may result in different reachable areas compared to using default speed limits. Value must be between 3.6 and 252 kilometers per hour.</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. This can affect route calculations by enabling the use of high-occupancy vehicle (HOV) lanes where minimum occupancy requirements are met.</p> <p>Default value: <code>1</code> </p>"""
    payload_capacity: "capo_geo_routes.types.weight_kilograms.WeightKilograms"
    """<p>The maximum cargo weight in kilograms that the vehicle (including attached trailers) is rated to carry.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>"""
    tire_count: NotRequired["capo_geo_routes.types.sensitive_integer.SensitiveInteger"]
    """<p>The total number of tires on the vehicle.</p>"""
    trailer: NotRequired[
        "capo_geo_routes.types.isoline_trailer_options.IsolineTrailerOptions"
    ]
    """<p>Optional specifications for attached trailers. When provided, trailer characteristics affect route calculations to ensure compliance with trailer-specific restrictions such as length limits, weight distribution requirements, and access restrictions for multi-trailer configurations.</p>"""
    truck_type: NotRequired["capo_geo_routes.types.isoline_truck_type.IsolineTruckType"]
    """<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>The heaviest weight per axle in kilograms, regardless of axle type or grouping. Used for roads with axle-weight restrictions in regions where regulations don't distinguish between different axle configurations.</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 different axle group configurations. Used in regions where regulations set different weight limits based on axle group types.</p> <p> <b>Unit</b>: <code>kilograms</code> </p>"""
    width: "capo_geo_routes.types.dimension_centimeters.DimensionCentimeters"
    """<p>The vehicle width in centimeters. Used to avoid routes with width restrictions.</p> <p> <b>Unit</b>: <code>centimeters</code> </p>"""

axle_count instance-attribute

axle_count: NotRequired[SensitiveInteger]

The total number of axles on the vehicle. Required for certain road restrictions and weight limit calculations.

engine_type instance-attribute

engine_type: NotRequired[IsolineEngineType]

The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.

  • INTERNAL_COMBUSTION—Standard gasoline or diesel engine.

  • ELECTRIC—Battery electric vehicle.

  • PLUGIN_HYBRID—Combination of electric and internal combustion engines with plug-in charging capability.

gross_weight instance-attribute

gross_weight: WeightKilograms

The gross vehicle weight (the maximum weight a vehicle can safely operate at, as specified by the manufacturer) in kilograms. Used to avoid roads with weight restrictions and ensure compliance with maximum allowed vehicle weight regulations.

Unit: kilograms

hazardous_cargos instance-attribute

hazardous_cargos: NotRequired[IsolineHazardousCargoTypeList]

Types of hazardous materials being transported. This affects which roads and tunnels can be used based on local regulations.

  • Combustible—Materials that can burn readily

  • Corrosive—Materials that can destroy or irreversibly damage other substances

  • Explosive—Materials that can produce an explosion by chemical reaction

  • Flammable—Materials that can easily ignite

  • Gas—Hazardous materials in gaseous form

  • HarmfulToWater—Materials that pose a risk to water sources if released

  • Organic—Hazardous organic compounds

  • Other—Hazardous materials not covered by other categories

  • Poison—Toxic materials

  • PoisonousInhalation—Materials that are toxic when inhaled

  • Radioactive—Materials that emit ionizing radiation

height instance-attribute

The vehicle height in centimeters. Used to avoid routes with low bridges or other height restrictions.

Unit: centimeters

height_above_first_axle instance-attribute

height_above_first_axle: DimensionCentimeters

The height in centimeters measured from the ground to the highest point above the first axle. Used for specific bridge and tunnel clearance restrictions.

Unit: centimeters

kpra_length instance-attribute

kpra_length: DimensionCentimeters

The kingpin to rear axle (KPRA) length in centimeters. Used to determine if the vehicle can safely navigate turns and intersections.

Unit: centimeters

length instance-attribute

The total vehicle length in centimeters. Used to avoid roads with length restrictions and determine if the vehicle can safely navigate turns.

Unit: centimeters

license_plate instance-attribute

license_plate: NotRequired[IsolineVehicleLicensePlate]

License plate information used in regions where road access or routing restrictions are based on license plate numbers.

max_speed instance-attribute

max_speed: NotRequired[SpeedKilometersPerHour]

The maximum speed in kilometers per hour at which the vehicle can or is permitted to travel. This affects travel time calculations and may result in different reachable areas compared to using default speed limits. Value must be between 3.6 and 252 kilometers per hour.

Unit: kilometers per hour

occupancy instance-attribute

occupancy: NotRequired[SensitiveInteger]

The number of occupants in the vehicle. This can affect route calculations by enabling the use of high-occupancy vehicle (HOV) lanes where minimum occupancy requirements are met.

Default value: 1

payload_capacity instance-attribute

payload_capacity: WeightKilograms

The maximum cargo weight in kilograms that the vehicle (including attached trailers) is rated to carry.

Unit: kilograms

tire_count instance-attribute

tire_count: NotRequired[SensitiveInteger]

The total number of tires on the vehicle.

trailer instance-attribute

trailer: NotRequired[IsolineTrailerOptions]

Optional specifications for attached trailers. When provided, trailer characteristics affect route calculations to ensure compliance with trailer-specific restrictions such as length limits, weight distribution requirements, and access restrictions for multi-trailer configurations.

truck_type instance-attribute

truck_type: NotRequired[IsolineTruckType]

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

The heaviest weight per axle in kilograms, regardless of axle type or grouping. Used for roads with axle-weight restrictions in regions where regulations don't distinguish between different axle configurations.

Unit: kilograms

weight_per_axle_group instance-attribute

weight_per_axle_group: NotRequired[WeightPerAxleGroup]

Specifies the total weight for different axle group configurations. Used in regions where regulations set different weight limits based on axle group types.

Unit: kilograms

width instance-attribute

The vehicle width in centimeters. Used to avoid routes with width restrictions.

Unit: centimeters