NextControl Units/dev.nextftc.units.unittypes/DistanceUnit

DistanceUnit

class DistanceUnit(baseUnit: DistanceUnit?, toBaseConverter: (Double) -> Double, fromBaseConverter: (Double) -> Double, unitName: String, unitSymbol: String) : Unit<DistanceUnit> (source)

Unit of measurement for distance/length.

Supported units include meters (base unit), millimeters, centimeters, kilometers, inches, feet, yards, and miles.

Constructors

DistanceUnit

constructor(baseUnit: DistanceUnit?, toBaseConverter: (Double) -> Double, fromBaseConverter: (Double) -> Double, unitName: String, unitSymbol: String)

constructor(baseUnit: DistanceUnit, baseUnitEquivalent: Double, name: String, symbol: String)

Convenience constructor for defining a derived distance unit from a base unit.

Properties

baseUnit

val baseUnit: DistanceUnit

The base unit for this unit's measurement system. This is found by traversing the parent chain until reaching a unit with no parent. For example:

Functions

equals

open operator override fun equals(other: Any?): Boolean

equivalent

fun equivalent(other: Unit<*>): Boolean

Checks if this unit is equivalent to another one. Equivalence is determined by both units having the same base type and treat the same base unit magnitude as the same magnitude in their own units, to within Measure.EQUIVALENCE_THRESHOLD.

fromBaseUnits

fun fromBaseUnits(valueInBaseUnits: Double): Double

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

hashCode

open override fun hashCode(): Int

isBaseUnit

fun isBaseUnit(): Boolean

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

name

fun name(): String

Gets the name of this unit.

open override fun of(magnitude: Double): Distance

Creates a new immutable measurement of the given magnitude in terms of this unit.

ofBaseUnits

open override fun ofBaseUnits(baseUnitMagnitude: Double): Measure<DistanceUnit>

Creates a new immutable measurement of the given magnitude in terms of this unit's base unit.

one

open fun one(): Measure<DistanceUnit>

Gets a measure with a magnitude of 1.0 in terms of this unit. The returned object is guaranteed to be of the same type returned by of. Subclasses are encouraged to override this method to sharpen the return type.

per

open override fun per(time: TimeUnit): LinearVelocityUnit

Combines this unit with a unit of time to create a velocity unit.

symbol

fun symbol(): String

Gets the symbol of this unit.

toBaseUnits

fun toBaseUnits(valueInNativeUnits: Double): Double

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

toString

open override fun toString(): String

zero

open fun zero(): Measure<DistanceUnit>

Gets a measure of zero magnitude in terms of this unit. The returned object is guaranteed to be of the same type returned by of. Subclasses are encouraged to override this method to sharpen the return type.