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: Ratio, val downhill: Ratio)

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

Link copied to clipboard
data class AltitudeChangeEnergy(val consumptionForAltitudeGain: ElectricConsumption, val recuperationForAltitudeLoss: ElectricConsumption)

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: Energy, val maxCharge: Energy)

Describes capacity and current charge of the EV.

Link copied to clipboard
data class ChargingConnector(val currentType: CurrentType, val plugTypes: List<ConnectorType>, val efficiency: Ratio = Ratio.unitRange(1), val baseLoad: Power = Power.ZERO, val maxPower: Power = Power.ZERO, val maxVoltage: Voltage = Voltage.ZERO, val maxCurrent: ElectricCurrent = ElectricCurrent.ZERO, val voltageRange: VoltageRange? = null)

Connector information of an electric engine.

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

Link copied to clipboard
data class ChargingParameters(val batteryCurve: Map<Energy, Power>, val chargingConnectors: List<ChargingConnector>, val chargingTimeOffset: Duration = 180.seconds)

Charging information of an electric engine.

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

Describes the vehicle with a combustion engine.

Link copied to clipboard
data class CombustionVehicleConsumption(val auxiliaryPower: FuelPerTime? = null, val speedConsumption: Map<Speed, FuelConsumption>)

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: EnergyDensity)

Specifies the efficiency of the vehicle.

Link copied to clipboard
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 for a charging park.

Link copied to clipboard

The type of connector which is used for EV charging.

Link copied to clipboard

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(val auxiliaryPower: Power? = null, val speedConsumption: Map<Speed, ElectricConsumption>)

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
value class FuelType constructor(type: Int)

The fuel types.

Link copied to clipboard

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

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: Weight? = null, val axleWeight: Weight? = null, val length: Distance? = null, val width: Distance? = null, val height: Distance? = null, val numberOfAxles: Int? = null)

Specifies the dimensions of the vehicle.

Link copied to clipboard

Represents the type of the vehicle.

Link copied to clipboard
data class VelocityChangeEfficiency(val acceleration: Ratio, val deceleration: Ratio)

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

Link copied to clipboard
data class VoltageRange(val minVoltage: Voltage, val maxVoltage: Voltage)

Voltage range is used to model DC boosters to be able to charge at DC charging parks with lower voltage in case the native required voltage is higher. Some cars might have this installed and it will affect the charging power. If it is not installed then it is not possible to charge at such station.