common:vehicle/com.tomtom.sdk.common.vehicle

Package-level declarations

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.

CargoCapable

interface CargoCapable

Trait interface for vehicles that may have restrictions due to load.

ChargeLevel

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

Describes capacity and current charge of the EV.

CombustionEngine

data class CombustionEngine(val consumption: CombustionVehicleConsumption? = null, val efficiency: CombustionVehicleEfficiency? = null, val currentFuel: Volume? = null)

Describes the vehicle with a combustion engine.

CombustionVehicleConsumption

data class CombustionVehicleConsumption @JvmOverloads constructor(val auxiliaryPower: FuelPerTime? = null, val speedConsumption: Map<Speed, FuelConsumption>)

Describes parameters used to determine the vehicle power and consumption.

CombustionVehicleEfficiency

data class CombustionVehicleEfficiency(val velocityChange: VelocityChangeEfficiency? = null, val altitudeChange: AltitudeChangeEfficiency? = null, val fuelEnergyDensity: EnergyDensity)

Specifies the efficiency of the vehicle.

ConsumptionModel

interface ConsumptionModel

Describes capacity and consumption of a vehicle.

ElectricEngine

data class ElectricEngine(val consumption: ElectricVehicleConsumption? = null, val efficiency: ElectricVehicleEfficiency? = null, val chargeLevel: ChargeLevel? = null)

Represents the electric vehicle descriptor used during a route plan.

ElectricVehicleConsumption

data class ElectricVehicleConsumption @JvmOverloads constructor(val auxiliaryPower: Power? = null, val speedConsumption: Map<Speed, ElectricConsumption>)

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

ElectricVehicleEfficiency

data class ElectricVehicleEfficiency(val velocityChange: VelocityChangeEfficiency? = null, val altitudeChange: AltitudeChangeEfficiency? = null, val altitudeChangeEnergy: AltitudeChangeEnergy? = null)

Specifies the efficiency of the vehicle.

Motorized

interface Motorized

Trait interface for vehicles that may have electric and/or combustion engines. These vehicles may also be subject to restrictions based on their size or weight.

Vehicle

abstract class Vehicle

Specifies the vehicle (or lack of one).

VehicleAdrTunnelRestrictionCode

enum VehicleAdrTunnelRestrictionCode : Enum<VehicleAdrTunnelRestrictionCode>

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

VehicleDimensions

data class VehicleDimensions(val weight: Weight? = null, val axleWeight: Weight? = null, val length: Distance? = null, val width: Distance? = null, val height: Distance? = null)

Specifies the dimensions 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.

VehicleType

@JvmInline

value class VehicleType

Represents the type of the vehicle.

VelocityChangeEfficiency

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

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