common:core/com.tomtom.kotlin.quantity/FuelConsumption

FuelConsumption

data class FuelConsumption : Quantity<FuelConsumption, FuelConsumption.Unit>

A quantity describing fuel consumption. (For example, 5 liters per 100 kilometers.)

Important: This is a Public Preview API. It may be changed or removed at any time.

Types

object Companion

enum Unit : Enum<FuelConsumption.Unit>

The unit of a FuelConsumption's value.

Functions

open override fun abs(): FuelConsumption

Returns a new instance with the value from this as absolute value.

open operator override fun compareTo(other: FuelConsumption): Int

open operator override fun div(divisor: Double): FuelConsumption

open operator override fun div(divisor: Int): FuelConsumption

Returns a new instance with the value from this divided by divisor.

inLitersPer100Kilometers

fun inLitersPer100Kilometers(): Double

Expresses the FuelConsumption's value in liters per 100 kilometers.

inMillilitersPer100Kilometers

fun inMillilitersPer100Kilometers(): Double

Expresses the FuelConsumption's value in milliliters per 100 kilometers.

inWholeLitersPer100Kilometers

fun inWholeLitersPer100Kilometers(): Long

inWholeMillilitersPer100Kilometers

fun inWholeMillilitersPer100Kilometers(): Long

open operator override fun minus(other: FuelConsumption): FuelConsumption

Returns a new instance that has other's value subtracted from this.

open operator override fun plus(other: FuelConsumption): FuelConsumption

Returns a new instance with a value equal to the sum of values from this and other.

open operator override fun times(factor: Double): FuelConsumption

open operator override fun times(factor: Int): FuelConsumption

Returns a new instance with the value from this multiplied by factor.

open override fun toDouble(unit: FuelConsumption.Unit): Double

Expresses the value of this under the given unit as a Double.

open override fun toLong(unit: FuelConsumption.Unit): Long

Expresses the value of this under the given unit as a Long.

open override fun toString(unit: FuelConsumption.Unit, decimals: Int, suffixMode: Quantity.SuffixMode, decimalsMode: Quantity.DecimalsMode): String

Returns a string representation for the value from this with the given unit. Depending on decimalsMode, it will show either exactly or at most decimals amount of decimals after the separator. The unit will be suffixed depending on suffixMode.

open operator override fun unaryMinus(): FuelConsumption

Returns a new instance with the value from this as negative.