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

Power

@Serializable

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

A quantity describing power. (For example, 10 kilowatts.)

Types

object Companion

enum Unit : Enum<Power.Unit>

The unit of a power's value.

Functions

open override fun abs(): Power

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

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

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

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

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

fun inKilowatts(): Double

Expresses the power's value in kilowatts.

fun inWatts(): Double

Expresses the power's value in watts.

inWholeKilowatts

fun inWholeKilowatts(): Long

Expresses the power's value in kilowatts rounded down.

fun inWholeWatts(): Long

Expresses the power's value in watts rounded down.

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

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

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

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

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

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

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

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

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

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

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

open override fun toString(): String

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

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