platform_evcharging_api_common_evcharging/com.tomtom.ivi.platform.evcharging.api.common.util

Package-level declarations

Types

class DistanceResourceStringResolver(distance: Distance, distanceMeasurementSystem: DistanceMeasurementSystem) : StringResolver

A StringResolver that takes a Distance value and resolves it to a String representation using the distance measurement system.

DistanceUtil

@IviExperimental(reasons = [])

class DistanceUtil(distanceMeasurementSystem: DistanceMeasurementSystem)

Formats distance to appropriate units depending on DistanceUnit.

Functions

getActiveEvChargingConnector

@IviInternal

@IviExperimental(reasons = [])

fun getActiveEvChargingConnector(chargingStation: ChargingStation?, chargingPointId: ChargingPointId?, connectorId: ConnectorId?): Connector?

getApproximatedChargingTime

@IviInternal

@IviExperimental(reasons = [])

fun getApproximatedChargingTime(currentChargeLevel: Energy?, desiredChargePercentage: Float?, chargingPointConnector: Connector, vehicleEvChargingConnector: VehicleEvChargingConnector?, batteryCapacity: Energy?, batteryCurve: List<VehicleEvChargingCurvePoint>?, chargingTimeOffset: Duration? = DEFAULT_CHARGING_OFFSET): Duration?

Returns the approximated time Duration at the charging stop, allowing for some additional time needed to use the charging facility or null if one of function parameter requirements listed below was not satisfied. When reaching the last percent before desired charge level, the function returns Duration of 0 minutes.

getBatteryLevelPercentage

@IviInternal

@IviExperimental(reasons = [])

fun getBatteryLevelPercentage(currentCharge: Energy, maxCharge: Energy): Float?

Returns percentage Float value for battery charge level or null if function requirements are not satisfied.

getCurrencyInstance

@IviInternal

@IviExperimental(reasons = [])

fun getCurrencyInstance(currencyCode: String?): Currency

Returns Currency instance for given 3 letter currency code. Returns default currency for locale if currency code is null or is not a valid ISO 4217 value.

getMatchingVehicleConnector

@IviInternal

@IviExperimental(reasons = [])

fun getMatchingVehicleConnector(chargingPointConnector: Connector?, vehicleConnectors: Set<VehicleEvChargingConnector>?): VehicleEvChargingConnector?

getMaximumConnectorChargingPower

@IviInternal

@IviExperimental(reasons = [])

fun getMaximumConnectorChargingPower(chargingPointConnector: Connector?, vehicleEvChargingConnector: VehicleEvChargingConnector?): Double?

isValidInputPattern

@IviInternal

@IviExperimental(reasons = [])

fun String.isValidInputPattern(): Boolean

Returns true if comma separated 2-letter country code string pattern is valid.

toAbbreviatedText

fun DistanceUnit.toAbbreviatedText(): StringResolver

Returns the string representation of the DistanceUnit.