BunyipsLib/au.edu.sa.mbhs.studentrobotics.bunyipslib.external.units/Velocity

Velocity

open class Velocity<D : Unit<D>?> : Unit<U>

Unit of velocity dimension that is a combination of a distance unit (numerator) and a time unit (denominator).

This is the base type for units of velocity dimension. It is also used in combination with a distance dimension to specify the dimension for Measure. For example: Measure<Velocity<Distance>>.

Actual units (such as MetersPerSecond and RPM) can be found in the Units class.

Since

1.0.0-pre

Parameters

<D>

the distance unit, such as Angle or Distance

Properties

Link copied to clipboard
@get:NonNull
val period: Time
Link copied to clipboard
val unit: D

Inherited properties

Link copied to clipboard
val baseUnit: U

Gets the base unit of measurement that this unit is derived from. If the unit is the base unit, the unit will be returned.

Link copied to clipboard
Link copied to clipboard
val converterFromBase: UnaryFunction

Gets the conversion function used to convert values to terms of this unit. This generally shouldn't need to be used directly; prefer fromBaseUnits instead.

Link copied to clipboard
val converterToBase: UnaryFunction

Gets the conversion function used to convert values to base unit terms. This generally shouldn't need to be used directly; prefer toBaseUnits instead.

Functions

Link copied to clipboard
@NonNull
open fun <D : Unit<D>?> combine(@NonNull numerator: Unit<D>, @NonNull period: Time): Velocity<D>
@NonNull
open fun <D : Unit<D>?> combine(@NonNull numerator: Unit<D>, @NonNull period: Time, @NonNull name: String, @NonNull symbol: String): Velocity<D>
Creates a new velocity unit derived from an arbitrary numerator and time period units.
Link copied to clipboard
open fun equals(other: Any): Boolean
Link copied to clipboard
open fun hashCode(): Int
Link copied to clipboard
@NonNull
open fun reciprocal(): Per<Time, D>
Returns the reciprocal of this velocity.

Inherited functions

Link copied to clipboard
fun convertFrom(magnitude: Double, otherUnit: Unit<U>): Double

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

Link copied to clipboard
fun equivalent(other: Unit<out Any>): 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.

Link copied to clipboard
infix fun <U : Unit<U>> Unit<U>.from(conversion: Pair<Double, Unit<U>>): Double

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

Link copied to clipboard
fun fromBaseUnits(valueInBaseUnits: Double): Double

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

Link copied to clipboard
fun isBaseUnit(): Boolean

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

Link copied to clipboard
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.

Link copied to clipboard
fun name(): String

Gets the name of this unit.

Link copied to clipboard
fun of(magnitude: Double): Measure<U>

Creates a new measure of this unit with the given value. The resulting measure is immutable and cannot have its value modified.

Link copied to clipboard
fun ofBaseUnits(baseUnitMagnitude: Double): Measure<U>

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

Link copied to clipboard
fun one(): Measure<U>

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

Link copied to clipboard
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.

fun per(period: Time): Velocity<U>

Creates a velocity unit derived from this one. Can be chained to denote velocity, acceleration, jerk, etc.

Link copied to clipboard
fun symbol(): String

Gets the symbol of this unit.

Link copied to clipboard
fun toBaseUnits(valueInNativeUnits: Double): Double

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

Link copied to clipboard
open fun toString(): String
Link copied to clipboard
fun zero(): Measure<U>

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