com.tomtom.sdk.vehicle:vehicle-provider/com.tomtom.sdk.vehicle.parameters

Package-level declarations

Types

data class AdrTunnelRestrictionCodeParameter(val adrTunnelRestrictionCode: AdrTunnelRestrictionCode) : VehicleParameter

Specifies the restriction level for tunnel usage according to 'European Agreement concerning the International Carriage of Dangerous Goods by Road' (ADR) tunnel restrictions.

AltitudeChangeEfficiencyParameter

data class AltitudeChangeEfficiencyParameter(val altitudeChangeEfficiency: AltitudeChangeEfficiency) : ElectricEngineParameter, CombustionEngineParameter

Specifies the ratio by which energy is converted during altitude changes. If used in a CombustionEngineParameter list, FuelEnergyDensity must also be specified.

AltitudeChangeEnergyParameter

data class AltitudeChangeEnergyParameter(val altitudeChangeEnergy: AltitudeChangeEnergy) : ElectricEngineParameter

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

AuxiliaryFuelPower

data class AuxiliaryFuelPower(val auxiliaryFuelPower: FuelPerTime) : CombustionEngineParameter

Specifies the vehicle auxiliary fuel consumption.

AuxiliaryPower

data class AuxiliaryPower(val auxiliaryPower: Power) : ElectricEngineParameter

Specifies the auxiliary consumption of the electric engine.

AxleWeight

data class AxleWeight(val axleWeight: Weight) : VehicleParameter

Specifies the axle weight of the vehicle.

BatteryCurve

data class BatteryCurve(val batteryCurve: Map<Energy, Power>) : ElectricEngineParameter

Specifies a curve that represents the variation in speed a which an EV battery charges.

ChargingConnectors

data class ChargingConnectors(val chargingConnectors: List<ChargingConnector>) : ElectricEngineParameter

Specifies a list of all the charging connectors that can be used for charging.

ChargingTimeOffset

data class ChargingTimeOffset(val chargingTimeOffset: Duration) : ElectricEngineParameter

Specifies the charging time offset which is added to the raw charging time.

CombustionEngineParameter

interface CombustionEngineParameter

Trait interface for combustion engine parameters.

CombustionEngineParameters

data class CombustionEngineParameters(val parameters: List<CombustionEngineParameter>) : VehicleParameter

Specifies the combustion engine parameters.

CommercialVehicle

data class CommercialVehicle(val isCommercialVehicle: Boolean) : VehicleParameter

Specifies commercial nature of the vehicle.

CurrentCharge

data class CurrentCharge(val currentCharge: Energy) : ElectricEngineParameter

Specifies current charge of the electric engine.

CurrentFuel

data class CurrentFuel(val currentFuel: Volume) : CombustionEngineParameter

Specifies the amount of fuel.

ElectricEngineParameter

interface ElectricEngineParameter

Trait interface for electric engine parameters.

ElectricEngineParameters

data class ElectricEngineParameters(val parameters: List<ElectricEngineParameter>) : VehicleParameter

Specifies the electric engine parameters.

FuelEnergyDensity

data class FuelEnergyDensity(val fuelEnergyDensity: EnergyDensity) : CombustionEngineParameter

Specifies the efficiency of the vehicle.

LoadType

data class LoadType(val loadType: Set<VehicleLoadType>) : VehicleParameter

Specifies types of cargo that may be classified as hazardous materials and restricted from some roads.

MaxCharge

data class MaxCharge(val maxCharge: Energy) : ElectricEngineParameter

Specifies capacity and current charge of the electric engine.

MaxSpeed

data class MaxSpeed(val maxSpeed: Speed) : VehicleParameter

Specifies the maximum speed of the vehicle.

SpeedConsumption

data class SpeedConsumption(@Size(min = 1, max = 25) val speedConsumption: Map<Speed, ElectricConsumption>) : ElectricEngineParameter

Specifies the consumption of the electric engine.

SpeedFuelConsumption

data class SpeedFuelConsumption(@Size(min = 1, max = 25) val speedConsumption: Map<Speed, FuelConsumption>) : CombustionEngineParameter

Specifies the vehicle fuel consumption.

VehicleHeight

data class VehicleHeight(val height: Distance) : VehicleParameter

Specifies the height of the vehicle.

VehicleLength

data class VehicleLength(val length: Distance) : VehicleParameter

Specifies the length of the vehicle.

VehicleParameter

interface VehicleParameter

Trait interface for vehicle parameters.

VehicleWeight

data class VehicleWeight(val vehicleWeight: Weight) : VehicleParameter

Specifies the weight of the vehicle.

VehicleWidth

data class VehicleWidth(val width: Distance) : VehicleParameter

Specifies the width of the vehicle.

VelocityChangeEfficiencyParameter

data class VelocityChangeEfficiencyParameter(val velocityChangeEfficiency: VelocityChangeEfficiency) : ElectricEngineParameter, CombustionEngineParameter

Specifies the ratio by which energy is converted during velocity changes. If used in a CombustionEngineParameter list, FuelEnergyDensity must also be specified.