Package-level declarations

Types

Link copied to clipboard

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

Link copied to clipboard
data class AltitudeChangeEfficiency(val uphill: <Error class: unknown class>, val downhill: <Error class: unknown class>)

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

Link copied to clipboard
data class AltitudeChangeEnergy(val consumptionForAltitudeGain: <Error class: unknown class>, val recuperationForAltitudeLoss: <Error class: unknown class>)

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

Link copied to clipboard
interface CargoCapable

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

Link copied to clipboard
data class ChargeLevel(val currentCharge: <Error class: unknown class>, val maxCharge: <Error class: unknown class>)

Describes capacity and current charge of the EV.

Link copied to clipboard
data class ChargingConnector(val currentType: CurrentType, val plugTypes: List<ConnectorType>)

Connector information of an electric engine. Important: This is a Public Preview API. It may be changed or removed at any time.

Link copied to clipboard
data class ChargingInformation(val targetCharge: <Error class: unknown class>, val chargingTime: <Error class: unknown class>, val chargingParkUuid: UUID, val connectorDetails: ConnectorDetails, val chargingPower: <Error class: unknown class>? = null)

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

Link copied to clipboard
data class ChargingParameters(val batteryCurve: Map<<Error class: unknown class>, <Error class: unknown class>>, val chargingConnectors: List<ChargingConnector>)

Charging information of an electric engine.

Link copied to clipboard
data class CombustionEngine(val consumption: CombustionVehicleConsumption? = null, val efficiency: CombustionVehicleEfficiency? = null, val currentFuel: <Error class: unknown class>? = null)

Describes the vehicle with a combustion engine.

Link copied to clipboard
data class CombustionVehicleConsumption constructor(val auxiliaryPower: <Error class: unknown class>? = null, val speedConsumption: Map<<Error class: unknown class>, <Error class: unknown class>>)

Describes parameters used to determine the vehicle power and consumption.

Link copied to clipboard
data class CombustionVehicleEfficiency(val velocityChange: VelocityChangeEfficiency? = null, val altitudeChange: AltitudeChangeEfficiency? = null, val fuelEnergyDensity: <Error class: unknown class>)

Specifies the efficiency of the vehicle.

Link copied to clipboard
data class ConnectorDetails(val connectorType: ConnectorType, val ratedPower: <Error class: unknown class>? = null, val current: <Error class: unknown class>? = null, val currentType: CurrentType? = null, val voltage: <Error class: unknown class>? = null)

Information about the connectors available in the ChargingPark.

Link copied to clipboard
value class ConnectorType

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

Link copied to clipboard
value class CurrentType

Electric current type of a connector.

Link copied to clipboard
data class ElectricEngine(val consumption: ElectricVehicleConsumption? = null, val efficiency: ElectricVehicleEfficiency? = null, val chargeLevel: ChargeLevel? = null, val chargingParameters: ChargingParameters? = null)

Represents the electric vehicle descriptor used during a route plan.

Link copied to clipboard
data class ElectricVehicleConsumption constructor(val auxiliaryPower: <Error class: unknown class>? = null, val speedConsumption: Map<<Error class: unknown class>, <Error class: unknown class>>)

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

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

Specifies the efficiency of the vehicle.

Link copied to clipboard
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.

Link copied to clipboard
abstract class Vehicle

Specifies the vehicle (or lack of one).

Link copied to clipboard
data class VehicleDimensions(val weight: <Error class: unknown class>? = null, val axleWeight: <Error class: unknown class>? = null, val length: <Error class: unknown class>? = null, val width: <Error class: unknown class>? = null, val height: <Error class: unknown class>? = null)

Specifies the dimensions of the vehicle.

Link copied to clipboard
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.

Link copied to clipboard
value class VehicleType

Represents the type of the vehicle.

Link copied to clipboard
data class VelocityChangeEfficiency(val acceleration: <Error class: unknown class>, val deceleration: <Error class: unknown class>)

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