Class VehicleProfile
- Last UpdatedMay 13, 2025
- 3 minute read
- java.lang.Object
-
- com.here.sdk.transport.VehicleProfile
-
public final class VehicleProfile extends java.lang.Object
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
Fields Modifier and Type Field Description java.lang.Integer
axleCount
Defines total number of axles in the vehicle.java.lang.Integer
grossWeightInKilograms
Vehicle weight including trailers and shipped goods in kilograms.java.util.List<HazardousMaterial>
hazardousMaterials
Specifies a list of hazardous materials shipped in the vehicle.java.lang.Integer
heightInCentimeters
Vehicle height in centimeters.java.lang.Integer
lengthInCentimeters
Vehicle length in centimeters.int
trailerCount
Defines number of trailers attached to the vehicle.TruckType
truckType
Defines the type of truck.TunnelCategory
tunnelCategory
Specifies the tunnel categories to restrict certain route links.VehicleType
vehicleType
Defines the vehicle type.java.lang.Integer
weightPerAxleInKilograms
Vehicle weight per axle in kilograms.java.lang.Integer
widthInCentimeters
Vehicle width in centimeters.
-
Constructor Summary
Constructors Constructor Description VehicleProfile(VehicleType vehicleType)
Creates a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
int
hashCode()
-
-
-
Field Detail
-
vehicleType
@NonNull public VehicleType vehicleType
Defines the vehicle type.
-
truckType
@Nullable public TruckType truckType
Defines the type of truck. Only used when the
vehicleType
isVehicleType.TRUCK
By default, it is not set.
-
trailerCount
public int trailerCount
Defines 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
@NonNull public java.util.List<HazardousMaterial> hazardousMaterials
Specifies a list of hazardous materials shipped in the vehicle. Refer to
HazardousMaterial
for the available options.
-
tunnelCategory
@Nullable public TunnelCategory tunnelCategory
Specifies the tunnel categories to restrict certain route links. The route will pass only through tunnels of a less strict category. Refer to
TunnelCategory
for the available options.
-
axleCount
@Nullable public java.lang.Integer 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
@Nullable public java.lang.Integer grossWeightInKilograms
Vehicle weight including trailers and shipped goods in kilograms. By default, it is not set.
-
heightInCentimeters
@Nullable public java.lang.Integer heightInCentimeters
Vehicle height in centimeters. The provided value must be in the range [0, 5000]. By default, it is not set.
-
lengthInCentimeters
@Nullable public java.lang.Integer lengthInCentimeters
Vehicle length in centimeters. The provided value must be in the range [0, 30000]. By default, it is not set.
-
widthInCentimeters
@Nullable public java.lang.Integer widthInCentimeters
Vehicle width in centimeters. The provided value must be in the range [0, 5000]. By default, it is not set.
-
weightPerAxleInKilograms
@Nullable public java.lang.Integer 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 Detail
-
VehicleProfile
public VehicleProfile(@NonNull VehicleType vehicleType)
Creates a new instance.
- Parameters:
vehicleType
-Defines the vehicle type.
-
-