sdk-routing / com.tomtom.online.sdk.routing.ev / VehicleDescriptor

VehicleDescriptor

@Beta(2020, 10) class VehicleDescriptor

Represents vehicle descriptor used during route plan.

Parameters

vehicleMaxSpeedInKph - Maximum speed of the vehicle in km/hour.

vehicleWeightInKg - Weight of the vehicle in kilograms.

vehicleAxleWeightInKg - Weight per axle of the vehicle in kg.

vehicleLengthInMeters - Length of the vehicle in meters.

vehicleWidthInMeters - Width of the vehicle in meters.

vehicleHeightInMeters - Height of the vehicle in meters.

isVehicleCommercial - Specifies whether the vehicle is used for commercial purposes and thus may not be allowed to drive on some roads.

uphillEfficiency - Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation.

downhillEfficiency - Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation.

accelerationEfficiency - Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates.

decelerationEfficiency - Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates.

Types

Builder

class Builder

Builder used to create an instance of VehicleDescriptor. Once constructed, the user cannot change the field values.

Constructors

<init>

VehicleDescriptor(vehicleMaxSpeedInKph: Int?, vehicleWeightInKg: Int?, vehicleAxleWeightInKg: Int?, vehicleLengthInMeters: Double?, vehicleWidthInMeters: Double?, vehicleHeightInMeters: Double?, isVehicleCommercial: Boolean?, uphillEfficiency: Double?, downhillEfficiency: Double?, accelerationEfficiency: Double?, decelerationEfficiency: Double?)

Represents vehicle descriptor used during route plan.

Properties

accelerationEfficiency

var accelerationEfficiency: Double?

Specifies the efficiency of converting chemical energy stored in fuel to kinetic energy when the vehicle accelerates.

decelerationEfficiency

var decelerationEfficiency: Double?

Specifies the efficiency of converting kinetic energy to saved (not consumed) fuel when the vehicle decelerates.

downhillEfficiency

var downhillEfficiency: Double?

Specifies the efficiency of converting potential energy to saved (not consumed) fuel when the vehicle loses elevation.

isVehicleCommercial

var isVehicleCommercial: Boolean?

Specifies whether the vehicle is used for commercial purposes and thus may not be allowed to drive on some roads.

uphillEfficiency

var uphillEfficiency: Double?

Specifies the efficiency of converting chemical energy stored in fuel to potential energy when the vehicle gains elevation.

vehicleAxleWeightInKg

var vehicleAxleWeightInKg: Int?

Weight per axle of the vehicle in kg.

vehicleHeightInMeters

var vehicleHeightInMeters: Double?

Height of the vehicle in meters.

vehicleLengthInMeters

var vehicleLengthInMeters: Double?

Length of the vehicle in meters.

vehicleMaxSpeedInKph

var vehicleMaxSpeedInKph: Int?

Maximum speed of the vehicle in km/hour.

vehicleWeightInKg

var vehicleWeightInKg: Int?

Weight of the vehicle in kilograms.

vehicleWidthInMeters

var vehicleWidthInMeters: Double?

Width of the vehicle in meters.