Energy

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

Types

Link copied to clipboard
object Companion
Link copied to clipboard

The unit of a energy's value.

Functions

Link copied to clipboard
open override fun abs(): Energy

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

Link copied to clipboard
open operator override fun compareTo(other: Energy): Int
Link copied to clipboard
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.

Link copied to clipboard

Expresses the energy's value in joules.

Link copied to clipboard

Expresses the energy's value in kilowatt-hours.

Link copied to clipboard

Expresses the energy's value in watt-hours.

Link copied to clipboard

Expresses the energy's value in joules rounded down.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
open operator override fun minus(other: Energy): Energy

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

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
open override fun toDouble(unit: Energy.Unit): Double

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

Link copied to clipboard
open override fun toLong(unit: Energy.Unit): Long

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

Link copied to clipboard
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.

Link copied to clipboard
open operator override fun unaryMinus(): Energy

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