routing:routing-client-api/com.tomtom.sdk.routing.api.vehicle

Package com.tomtom.sdk.routing.api.vehicle

Types

data class AltitudeChangeEfficiency(val uphill: Double, val downhill: Double)

Specifies the ratio by which energy is converted for altitude changes.

data class AltitudeChangeEnergy(val consumptionForAltitudeGain: ElectricConsumption, val recuperationForAltitudeLoss: ElectricConsumption)

Specifies the energy that is gained or lost by altitude changes.

Budget

abstract class Budget

Either of Budget.Fuel, Budget.Energy, Budget.Time or Budget.Distance.

ChargeLevel

data class ChargeLevel(val currentCharge: Energy, val maxCharge: Energy)

Important: This is a Public Preview API. It may be changed or removed at any time. Describes capacity and current charge of the EV.

CombustionEngine

data class CombustionEngine(val vehicleConsumption: CombustionVehicleConsumption? = null, val vehicleEfficiency: VehicleEfficiency? = null)

Describes the vehicle with a combustion engine.

CombustionVehicleConsumption

data class CombustionVehicleConsumption @JvmOverloads constructor( val currentFuelInLiters: Double? = null, val auxiliaryPowerInLitersPerHour: Double? = null, val fuelEnergyDensityInMJoulesPerLiter: Double? = null, val speedConsumptionInLitersPerHundredKm: Map<Double, Double>)

Describes parameters used to determine the vehicle power and consumption.

ConsumptionModel

interface ConsumptionModel

Describes capacity and consumption of a vehicle.

ElectricEngine

data class ElectricEngine(val vehicleConsumption: ElectricVehicleConsumption? = null, val vehicleEfficiency: VehicleEfficiency? = null)

Represents the electric vehicle descriptor used during a route plan.

ElectricVehicleConsumption

data class ElectricVehicleConsumption @JvmOverloads constructor( val currentChargeInkWh: Double? = null, val maxChargeInkWh: Double? = null, val auxiliaryPowerInkW: Double? = null, val speedConsumptionInKWhPerHundredKm: Map<Double, Double>)

Important: This is a Public Preview API. It may be changed or removed at any time. Describes capacity and the consumption of the EV.

Vehicle

data class Vehicle( val vehicleMaxSpeedInKph: Int? = null, val isVehicleCommercial: Boolean? = null, val vehicleLoadType: Set<VehicleLoadType> = emptySet(), val vehicleAdrTunnelRestrictionCode: VehicleAdrTunnelRestrictionCode? = null, val vehicleDimensions: VehicleDimensions? = null, val electricEngine: ElectricEngine? = null, val combustionEngine: CombustionEngine? = null)

Specifies the restriction that this vehicle should be subjected to.

VehicleAdrTunnelRestrictionCode

enum VehicleAdrTunnelRestrictionCode : Enum<VehicleAdrTunnelRestrictionCode>

Specifies if the vehicle should be subjected to ADR tunnel restrictions.

VehicleDimensions

data class VehicleDimensions( val vehicleWeightInKg: Int? = null, val vehicleAxleWeightInKg: Int? = null, val vehicleLength: Distance? = null, val vehicleWidth: Distance? = null, val vehicleHeight: Distance? = null)

Specifies the dimensions of the vehicle.

VehicleEfficiency

data class VehicleEfficiency( val uphillEfficiency: Double? = null, val downhillEfficiency: Double? = null, val accelerationEfficiency: Double? = null, val decelerationEfficiency: Double? = null)

Specifies the efficiency of the vehicle.

VehicleEngineType

enum VehicleEngineType : Enum<VehicleEngineType>

Represents the types of the vehicle engine (e.g., electric).

VehicleLoadType

enum VehicleLoadType : Enum<VehicleLoadType>

Represents types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are US Hazmat classes 1 through 9, plus generic classifications for use in other countries. For more details, see: https://developer.tomtom.com/routing-api/routing-api-documentation-routing/common-routing-parameters.

VelocityChangeEfficiency

data class VelocityChangeEfficiency(val acceleration: Double, val deceleration: Double)

Specifies the ratio by which energy is converted during velocity changes.