VehicleProfile (API Reference)
Class VehicleProfile
A vehicle profile describes the vehicle being used with the HSDK.
The profile is planned to be used as single source of information describing the vehicle.
Current modules that use this profile:
- Navigation: Tracking mode for truck related vehicle restrictions.
Note: This is a beta release of this vehicle profile, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases or even become unsupported, without a deprecation process.
-
Field Summary
FieldsModifier and TypeFieldDescriptionDefines total number of axles in the vehicle.Vehicle weight including trailers and shipped goods in kilograms.Specifies a list of hazardous materials shipped in the vehicle.Vehicle height in centimeters.Vehicle length in centimeters.intDefines number of trailers attached to the vehicle.Defines the truck category.Specifies the tunnel categories to restrict certain route links.Defines the vehicle type.Vehicle weight per axle in kilograms.Vehicle width in centimeters. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
vehicleType
Defines the vehicle type.
-
truckCategory
Defines the truck category. Only used when the
vehicleTypeisVehicleType.TRUCKBy default, it is not set. -
trailerCount
public int trailerCountDefines number of trailers attached to the vehicle. The provided value must be in the range [0, 255]. When not set, possible trailer count restrictions will not be taken into consideration for route calculation. By default, it is 0.
-
hazardousMaterials
Specifies a list of hazardous materials shipped in the vehicle. Refer to
HazardousMaterialfor the available options. -
tunnelCategory
Specifies the tunnel categories to restrict certain route links. The route will pass only through tunnels of a less strict category. Refer to
TunnelCategoryfor the available options. -
axleCount
Defines total number of axles in the vehicle. The provided value must be greater than or equal to 2. When not set, possible axle count restrictions will not be taken into consideration for route calculation. By default, it is not set.
-
grossWeightInKilograms
Vehicle weight including trailers and shipped goods in kilograms. By default, it is not set.
-
heightInCentimeters
Vehicle height in centimeters. The provided value must be in the range [0, 5000]. By default, it is not set.
-
lengthInCentimeters
Vehicle length in centimeters. The provided value must be in the range [0, 30000]. By default, it is not set.
-
widthInCentimeters
Vehicle width in centimeters. The provided value must be in the range [0, 5000]. By default, it is not set.
-
weightPerAxleInKilograms
Vehicle weight per axle in kilograms. The provided value must be greater or equal to 0. When not set, possible weight per axle restrictions will not be taken into consideration for route calculation. By default, it is not set.
-
-
Constructor Details
-
VehicleProfile
Creates a new instance.
- Parameters:
vehicleType-Defines the vehicle type.
-
-
Method Details