VehicleProfile class - transport library - Dart API
VehicleProfile
VehicleProfile class
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.
Constructors
- VehicleProfile(VehicleType vehicleType)
- Creates a new instance.
Properties
- axleCount ↔ int?
-
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.
getter/setter pair
- grossWeightInKilograms ↔ int?
-
Vehicle weight including trailers and shipped goods in kilograms.
By default, it is not set.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setter
-
hazardousMaterials
↔ List<
HazardousMaterial> -
Specifies a list of hazardous materials shipped in the vehicle.
Refer to HazardousMaterial for the available options.
getter/setter pair
- heightInCentimeters ↔ int?
-
Vehicle height in centimeters. The provided value must be in the range [0, 5000].
By default, it is not set.
getter/setter pair
- lengthInCentimeters ↔ int?
-
Vehicle length in centimeters. The provided value must be in the range [0, 30000].
By default, it is not set.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- trailerCount ↔ int
-
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.
getter/setter pair
- truckCategory ↔ TruckCategory?
-
Defines the truck category.
Only used when the VehicleProfile.vehicleType is VehicleType.truck
By default, it is not set.
getter/setter pair
- 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.
getter/setter pair
- vehicleType ↔ VehicleType
-
Defines the vehicle type.
getter/setter pair
- weightPerAxleInKilograms ↔ int?
-
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.
getter/setter pair
- widthInCentimeters ↔ int?
-
Vehicle width in centimeters. The provided value must be in the range [0, 5000].
By default, it is not set.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool - The equality operator.