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

EnergyDensity

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

A quantity describing energy density. (For example, 4.5 megajoules per liter.)

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

Types

object Companion

enum Unit : Enum<EnergyDensity.Unit>

The unit of an EnergyDensity's value.

Functions

open override fun abs(): EnergyDensity

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

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

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

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

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

inJoulesPerLiter

fun inJoulesPerLiter(): Double

Expresses the energyDensity's value in joules.

inMegajoulesPerLiter

fun inMegajoulesPerLiter(): Double

Expresses the energyDensity's value in joules.

inWholeJoulesPerLiter

fun inWholeJoulesPerLiter(): Long

Expresses the energyDensity's value in joules.

inWholeMegajoulesPerLiter

fun inWholeMegajoulesPerLiter(): Long

Expresses the energyDensity's value in joules.

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

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

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

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

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

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

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

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

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

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

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

open override fun toString(unit: EnergyDensity.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(): EnergyDensity

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