vehicle:model/com.tomtom.sdk.vehicle

Package-level declarations

Types

AdrTunnelRestrictionCode

enum AdrTunnelRestrictionCode : Enum<AdrTunnelRestrictionCode>

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

AltitudeChangeEfficiency

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

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

AltitudeChangeEnergy

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.

ChargingInformation

data class ChargingInformation(val targetCharge: Energy, val chargingTime: Duration, val chargingParkUuid: UUID, val connectorDetails: ConnectorDetails, val chargingPower: Power? = null)

Represents the information on how much to charge at a charging station.

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.

ConnectorDetails

data class ConnectorDetails(val connectorType: ConnectorType, val ratedPower: Power? = null, val current: ElectricCurrent? = null, val currentType: CurrentType? = null, val voltage: Voltage? = null)

Information about the connectors available in the ChargingPark.

ConnectorType

@JvmInline

value class ConnectorType

The connector type. This list is based on the supported connector types by online search, documented at the following link:

ConsumptionModel

interface ConsumptionModel

Describes capacity and consumption of a vehicle.

CurrentType

@JvmInline

value class CurrentType

Electric current type of a connector.

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).

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.

VehicleLoadType

@JvmInline

value class VehicleLoadType

Represents types of cargo that may be classified as hazardous materials and restricted from some roads. Available vehicleLoadType values are UN Hazmat classes 1 through 9, plus generic classifications for use in other countries.

VehicleType

@JvmInline

value class VehicleType

Represents the type of the vehicle.

VelocityChangeEfficiency

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

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