common:core/com.tomtom.kotlin.quantity/ElectricCurrent

ElectricCurrent

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

A quantity describing an electric current. (For example, 10 amperes.)

Important: This is a Public Preview API. It may be changed or removed at any time.

Types

object Companion

enum Unit : Enum<ElectricCurrent.Unit>

The unit of an electric current's value.

Functions

open override fun abs(): ElectricCurrent

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

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

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

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

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

fun inAmperes(): Double

Expresses the electric current's value in amperes.

fun inWholeAmperes(): Long

Expresses the electric current's value in amperes.

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

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

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

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

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

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

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

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

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

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

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

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

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