BunyipsLib/org.murraybridgebunyips.bunyipslib.external.units/Current

Current

Unit of electric current dimension.

This is the base type for units of current dimension. It is also used to specify the dimension for Measure: Measure<Current>.

Actual units (such as Amps and Milliamps) can be found in the Units class.

Since

1.0.0-pre

Inherited properties

baseUnit

val baseUnit: U

Functions

times

open fun times(voltage: Unit<Voltage>, name: String, symbol: String): Power

Constructs a unit of power equivalent to this unit of electrical current multiplied by another unit of voltage.

Inherited functions

convertFrom

open fun convertFrom(magnitude: Double, otherUnit: Unit): Double

Converts a magnitude in terms of another unit of the same dimension to a magnitude in terms of this unit.

equals

open fun equals(o: Any): Boolean

equivalent

open fun equivalent(other: Unit<out Any>): Boolean

Checks if this unit is equivalent to another one.

fromBaseUnits

open fun fromBaseUnits(valueInBaseUnits: Double): Double

Converts a value in terms of base units to a value in terms of this unit.

getConverterFromBase

open fun getConverterFromBase(): UnaryFunction

Gets the conversion function used to convert values to terms of this unit.

getConverterToBase

open fun getConverterToBase(): UnaryFunction

Gets the conversion function used to convert values to base unit terms.

hashCode

open fun hashCode(): Int

isBaseUnit

open fun isBaseUnit(): Boolean

Checks if this unit is the base unit for its own system of measurement.

mult

open fun <U2 : Unit<U2>?> mult(other: U2): Mult<U, U2>

Takes this unit and creates a new combinatory unit equivalent to this unit multiplied by another.

name

open fun name(): String

Gets the name of this unit.

open fun of(magnitude: Double): Measure

Creates a new measure of this unit with the given value.

ofBaseUnits

open fun ofBaseUnits(baseUnitMagnitude: Double): Measure

Creates a new measure with a magnitude equal to the given base unit magnitude, converted to be in terms of this unit.

one

open fun one(): Measure

Gets a measure with a magnitude of 1 in terms of this unit.

per

open fun <D : Unit<D>?> per(denominator: D): Per<U, D>

Takes this unit and creates a new proportional unit where this unit is the numerator and the given denominator is the denominator.

open fun per(period: Time): Velocity

Creates a velocity unit derived from this one.

symbol

open fun symbol(): String

Gets the symbol of this unit.

toBaseUnits

open fun toBaseUnits(valueInNativeUnits: Double): Double

Converts a value in terms of this unit to a value in terms of the base unit.

toString

@NonNull

open fun toString(): String

zero

open fun zero(): Measure

Gets a measure with a magnitude of 0 in terms of this unit.