Guidesv3.2 API Referencev3.1 API Reference

Interface: ITruckSpecs

Interface: ITruckSpecs

Interface: ITruckSpecs

This interface represents the specifications of a vehicle of type truck.

Extends

Members

H.service.omv.Provider.ITruckSpecs.HazardousMaterial number static

An enum containing bitmask values for different types of hazardous materials. Used to specify hazardous materials carried by the truck.

Properties:
Name Description
COMBUSTIBLE

Combustible material.

CORROSIVE

Corrosive material.

EXPLOSIVE

Explosive material.

FLAMMABLE

Flammable material.

GAS

Gas.

HARMFUL_TO_WATER

Materials that are harmful to water.

ORGANIC

Organic material.

OTHER

Any other hazardous material.

POISON

Poisonous material.

POISONOUS_INHALATION

Materials that are poisonous upon inhalation.

RADIOACTIVE

Radioactive material.

H.service.omv.Provider.ITruckSpecs.TruckType number static

An enum containing different types of trucks.

Properties:
Name Description
STRAIGHT

A truck on a single frame with a permanently attached cargo area.

TRACTOR

A towing vehicle that can pull one or more semi-trailers (AKA semi-truck.)

H.service.omv.Provider.ITruckSpecs.TunnelCategory number static

An enum containing different types of Tunnel Categories, each specifying a cargo tunnel restriction code.

For more information on tunnel categories, please refer to the ADR 2025 - Agreement concerning the International Carriage of Dangerous Goods by Road.

Properties:
Name Description
B

Tunnel Category B.

C

Tunnel Category C.

D

Tunnel Category D.

E

Tunnel Category E.

H.service.omv.Provider.ITruckSpecs.VehicleType H.service.omv.Provider.IVehicleSpecs.VehicleType static

The type of vehicle.

axleCount number | undefined

Total number of axles in the vehicle. If this value is not defined, the restriction will not be displayed.

grossWeightInKilograms number | undefined

Gross vehicle weight in kilograms, including trailers and shipped goods when loaded at capacity. If this value is not defined, the restriction will not be displayed.

Specifies a bitmask of hazardous materials carried by the vehicle. If this value is not defined, the restriction will not be displayed.

Note: setting this property will not automatically setup the corresponding tunnel category. It is recommended to set the tunnelCategory property as well, to ensure that the vehicle profile is checked against the correct tunnel restrictions.

heightInCentimeters number | undefined

Total vehicle height in centimeters. If this value is not defined, the restriction will not be displayed.

kpraInCentimeters number | undefined

Length from the kingpin to the rear axle, in centimeters. If this value is not defined, the restriction will not be displayed.

lengthInCentimeters number | undefined

Total vehicle length in centimeters. If this value is not defined, the restriction will not be displayed.

preferredTruckRouteTypes Array.<number> | undefined

Specifies the list of preferred truck route types. If this value is not defined, all preferred truck routes will be displayed.

For more information on the supported truck route types, please refer to the PreferredRouteType docs page.

Note: displaying preferred truck routes requires the 'truck preferred roads' feature to be enabled. For more information, see the Visualizing vehicle restrictions dev guide page.

trailerCount number | undefined

Number of trailers attached to the vehicle. If this value is not defined, the restriction will not be displayed.

Defines the type of truck. If this value is not defined, the restriction will not be displayed.

Specifies the cargo tunnel restriction code. If this value is not defined, the restriction will not be displayed.

The categories range from B to E:

  • Vehicle's tunnel category set to B - transport is forbidden through tunnels displaying signs: B,C,D or E
  • Vehicle's tunnel category set to C - transport is forbidden through tunnels displaying signs: C,D,E
  • Vehicle's tunnel category set to D - transport is forbidden through tunnels displaying signs: D,E
  • Vehicle's tunnel category set to E - transport is forbidden through tunnels displaying sign E only

Note: setting this property will not automatically setup the corresponding hazardous materials bitmask. It is recommended to set the hazardousMaterial property as well, to ensure that the vehicle profile is checked against the correct hazardous materials restrictions.

The type of vehicle.

Defines the weight in kilograms of the different axle groups of a truck. If this value is not defined, the restriction will not be displayed.

Note: the axle group weight is not the same as the per-axle weight, which is defined by weightPerAxleInKilograms, yet in case weightPerAxleInKilograms is not defined, the heaviest defined axle group weight will be used against the per-axle weight restrictions.

weightPerAxleInKilograms number | undefined

Heaviest axle weight in kilograms regardless of axle type or group. If this value is not defined, the restriction will not be displayed.

Note: the per-axle weight is not the same as the axle group weight, which is defined by weightPerAxleGroup, yet in case weightPerAxleGroup is not defined, weightPerAxleInKilograms will be used against the axle group restrictions.

widthInCentimeters number | undefined

Total vehicle width in centimeters. If this value is not defined, the restriction will not be displayed.

Interface Definitions

H.service.omv.Provider.ITruckSpecs.WeightPerAxleGroup

Struct which defines the weight of the different axle groups of a truck. The provided values must be greater or equal to 0. Used for filtering axle group weight restrictions.