api_quantity/com.tomtom.tools.android.api.quantity/Energy

Energy

@Serializable

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

A quantity describing energy. (For example, 10 kilowatt-hours.)

Types

object Companion

enum Unit : Enum<Energy.Unit>

The unit of a energy's value.

Functions

open override fun abs(): Energy

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

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

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

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

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

fun inJoules(): Double

Expresses the energy's value in joules.

inKilowattHours

fun inKilowattHours(): Double

Expresses the energy's value in kilowatt-hours.

fun inWattHours(): Double

Expresses the energy's value in watt-hours.

fun inWholeJoules(): Long

Expresses the energy's value in joules rounded down.

inWholeKilowattHours

fun inWholeKilowattHours(): Long

Expresses the energy's value in kilowatt-hours rounded down.

inWholeWattHours

fun inWholeWattHours(): Long

Expresses the energy's value in watt-hours rounded down.

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

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

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

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

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

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

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

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

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

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

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

open override fun toString(): String

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

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