Voltage

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

A quantity describing voltage. (For example, 10 volts.)

Types

Link copied to clipboard
object Companion
Link copied to clipboard
enum Unit : Enum<Voltage.Unit>

The unit of a voltage's value.

Functions

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

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

Link copied to clipboard
open operator override fun compareTo(other: Voltage): Int
Link copied to clipboard
open operator override fun div(divisor: Double): Voltage
open operator override fun div(divisor: Int): Voltage

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

Link copied to clipboard
fun inVolts(): Double

Expresses the voltage's value in volts.

Link copied to clipboard
fun inWholeVolts(): Long

Expresses the voltage's value in volts rounded down.

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

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

Link copied to clipboard
open operator override fun plus(other: Voltage): Voltage

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): Voltage
open operator override fun times(factor: Int): Voltage

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

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

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

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

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

Link copied to clipboard
open override fun toString(unit: Voltage.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(): Voltage

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

Inherited functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)