quantity/com.tomtom.quantity/Energy

Energy

class Energy : Quantity<Energy, Energy.Unit>

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

Types

Companion

object Companion

Unit

abstract class Unit : UnitBase

Energy units.

Functions

abs

fun abs(): Energy

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

compareTo

operator override fun compareTo(other: Energy): Int

div

operator fun div(divisor: Energy): Double

operator fun div(divisor: Double): Energy

operator fun div(divisor: Int): Energy

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

equals

open operator override fun equals(other: Any?): Boolean

format

fun format(unit: Energy.Unit): Quantity.FormattedQuantity

Returns a FormattedQuantity representation of the value from this in the given unit.

hashCode

open override fun hashCode(): Int

inJoules

fun inJoules(): Double

Expresses the energy's value in joules.

inKilowattHours

fun inKilowattHours(): Double

Expresses the energy's value in kilowatt-hours.

inWattHours

fun inWattHours(): Double

Expresses the energy's value in watt-hours.

inWholeJoules

fun inWholeJoules(): Long

Expresses the energy's value in joules.

inWholeKilowattHours

fun inWholeKilowattHours(): Long

Expresses the energy's value in kilowatt-hours.

inWholeWattHours

fun inWholeWattHours(): Long

Expresses the energy's value in watt-hours.

minus

operator fun minus(other: Energy): Energy

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

plus

operator fun plus(other: Energy): Energy

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

times

operator fun times(factor: Double): Energy

operator fun times(factor: Int): Energy

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

toString

open override fun toString(): String

unaryMinus

operator fun unaryMinus(): Energy

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