com.tomtom.quantity:quantity/com.tomtom.quantity/Energy

Energy

@JvmInline
value class Energy : Quantity<Energy, Energy.Unit>

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

Types

Link copied to clipboard
object Companion
Link copied to clipboard
abstract class Unit : UnitBase

Energy units.

Properties

Link copied to clipboard
open override val rawValue: Long

Raw unformatted value.

Functions

Link copied to clipboard
open operator override fun div(divisor: Energy): Double
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
fun inJoules(): Double

Expresses the energy's value in joules.

Link copied to clipboard
fun inKilowattHours(): Double

Expresses the energy's value in kilowatt-hours.

Link copied to clipboard
fun inWattHours(): Double

Expresses the energy's value in watt-hours.

Link copied to clipboard
fun inWholeJoules(): Long

Expresses the energy's value in joules.

Link copied to clipboard
fun inWholeKilowattHours(): Long

Expresses the energy's value in kilowatt-hours.

Link copied to clipboard
fun inWholeWattHours(): Long

Expresses the energy's value in watt-hours.

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 override fun selfFactory(rawValue: Long): Energy

Creates a new instance with the provided rawValue.

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 toString(): String

Returns a formatted value.

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

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

Inherited functions

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

Compares this object with the other object.

Link copied to clipboard
open fun format(unit: Energy.Unit): Quantity.FormattedQuantity

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

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

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

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

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