Units

class Units

Contains and exposes a set of predefined units.

Since

1.0.0-pre

Properties

Link copied to clipboard
The base unit of electrical current.
Link copied to clipboard
The base unit of electrical current.
Link copied to clipboard
The base SI unit of temperature, where a value of 0 roughly corresponds to the freezing point of water and a value of 100 corresponds to the boiling point.
Link copied to clipboard
1/100 of a Meter.
Link copied to clipboard
1/100 of a Meter.
Link copied to clipboard
1/360 of a turn around a circle, or 1/57.
Link copied to clipboard
1/360 of a turn around a circle, or 1/57.
Link copied to clipboard
A unit of angular velocity equivalent to spinning at a rate of one Degree per Second.
Link copied to clipboard
A unit of angular acceleration equivalent to accelerating at a rate of one Degree per Second every second.
Link copied to clipboard
The base imperial (American) unit of temperature, where a value of 32 roughly corresponds to the freezing point of water and a value of 212 corresponds to the boiling point.
Link copied to clipboard
304.
Link copied to clipboard
A unit of linear velocity equivalent to travelling at a rate one Foot per Second.
Link copied to clipboard
A unit of linear acceleration equivalent to accelerating at a rate of one Foot per Second every second.
Link copied to clipboard
24 inches, equivalent to 1 FTC Field Tile per unit
Link copied to clipboard
24 inches, equivalent to 1 FTC Field Tile per unit
Link copied to clipboard
304.
Link copied to clipboard
val Gram: Mass
1/1000 of a Kilogram.
Link copied to clipboard
val Grams: Mass
1/1000 of a Kilogram.
Link copied to clipboard
A unit of acceleration equivalent to the pull of gravity on an object at sea level on Earth.
Link copied to clipboard
A unit equal to 745.
Link copied to clipboard
25.
Link copied to clipboard
Link copied to clipboard
A unit of linear velocity equivalent to travelling at a rate of one Inch per Second.
Link copied to clipboard
A unit of linear acceleration equivalent to accelerating at a rate of one Inch per Second every second.
Link copied to clipboard
The base unit of energy.
Link copied to clipboard
The base unit of energy.
Link copied to clipboard
The base unit of temperature, where a value of 0 corresponds with absolutely zero energy in the measured system.
Link copied to clipboard
The base SI unit of mass.
Link copied to clipboard
The base SI unit of mass.
Link copied to clipboard
The base SI unit for moment of inertia.
Link copied to clipboard
A unit equal to 1,000 Joules.
Link copied to clipboard
A unit equal to 1,000 Joules.
Link copied to clipboard
The base unit of distance.
Link copied to clipboard
The base unit of distance.
Link copied to clipboard
The standard SI unit of linear velocity, equivalent to travelling at a rate of one Meter per Second.
Link copied to clipboard
The standard SI unit of linear acceleration, equivalent to accelerating at a rate of one Meter per Second every second.
Link copied to clipboard
Alias for Microseconds to make combined unit definitions read more smoothly.
Link copied to clipboard
1/1,000,000 of a Second.
Link copied to clipboard
A unit equal to 1/1000 of an Amp.
Link copied to clipboard
A unit equal to 1/1000 of an Amp.
Link copied to clipboard
A unit equal to 1/1000 of a Joule.
Link copied to clipboard
A unit equal to 1/1000 of a Joule.
Link copied to clipboard
1/1000 of a Meter.
Link copied to clipboard
1/1000 of a Meter.
Link copied to clipboard
Alias for Milliseconds to make combined unit definitions read more smoothly.
Link copied to clipboard
1/1000 of a Second.
Link copied to clipboard
1/1000 of a Volt.
Link copied to clipboard
1/1000 of a Volt.
Link copied to clipboard
A unit equal to 1/1000 of a Watt.
Link copied to clipboard
A unit equal to 1/1000 of a Watt.
Link copied to clipboard
Alias for Minutes to make combined unit definitions read more smoothly.
Link copied to clipboard
Link copied to clipboard
Alias for Nanoseconds to make combined unit definitions read more smoothly.
Link copied to clipboard
1/1,000,000,000 of a Second.
Link copied to clipboard
val Ounce: Mass
1/16 of a Pound.
Link copied to clipboard
1/16 of a Pound.
Link copied to clipboard
A dimensionless unit equal to to 1/100th of a Value.
Link copied to clipboard
val Pound: Mass
A unit of mass equivalent to approximately 453 Grams.
Link copied to clipboard
A unit of mass equivalent to approximately 453 Grams.
Link copied to clipboard
The base SI unit of angle, represented by the distance that the radius of a unit circle can wrap around its circumference.
Link copied to clipboard
The base SI unit of angle, represented by the distance that the radius of a unit circle can wrap around its circumference.
Link copied to clipboard
The standard SI unit of angular velocity, equivalent to spinning at a rate of one Radian per Second.
Link copied to clipboard
The standard SI unit of angular acceleration, equivalent to accelerating at a rate of one Radian per Second every second.
Link copied to clipboard
A single turn of an object around an external axis.
Link copied to clipboard
A single turn of an object around an external axis.
Link copied to clipboard
A unit of angular velocity equivalent to spinning at a rate of one Revolution per Second.
Link copied to clipboard
A single turn of an object around an internal axis.
Link copied to clipboard
A single turn of an object around an internal axis.
Link copied to clipboard
A unit of angular velocity equivalent to spinning at a rate of one Rotation per Second.
Link copied to clipboard
A unit of angular acceleration equivalent to accelerating at a rate of one Rotation per Second every second.
Link copied to clipboard
A unit of angular velocity equivalent to spinning at a rate of one Rotation per Minute.
Link copied to clipboard
Alias for Seconds to make combined unit definitions read more smoothly.
Link copied to clipboard
The base unit of time.
Link copied to clipboard
A dimensionless unit that performs no scaling whatsoever.
Link copied to clipboard
The base unit of electric potential.
Link copied to clipboard
The base unit of electric potential.
Link copied to clipboard
A standard unit for measuring linear mechanisms' feedforward voltages based on a model of the system and a desired commanded linear velocity.
Link copied to clipboard
A standard unit for measuring linear mechanisms' feedforward voltages based on a model of the system and a desired commanded linear acceleration.
Link copied to clipboard
A standard unit for measuring angular mechanisms' feedforward voltages based on a model of the system and a desired commanded angular velocity.
Link copied to clipboard
A standard unit for measuring angular mechanisms' feedforward voltages based on a model of the system and a desired commanded angular acceleration.
Link copied to clipboard
val Watt: Power
The base unit of power.
Link copied to clipboard
The base unit of power.

Functions

Link copied to clipboard
open fun <U : Unit<U>?> derive(@NonNull unit: Unit<U>): UnitBuilder<U>
Creates a new unit builder object based on a given input unit.
Link copied to clipboard
open fun <U : Unit<U>?> Kilo(@NonNull baseUnit: Unit<U>): U
open fun <U : Unit<U>?> Kilo(@NonNull baseUnit: Unit<U>, @NonNull name: String, @NonNull symbol: String): U
Creates a unit equal to a thousand of the base unit, eg Kilograms = Kilo(Units.Grams).
Link copied to clipboard
open fun <U : Unit<U>?> Micro(@NonNull baseUnit: Unit<U>): U
Creates a unit equal to a millionth of the base unit, eg Microseconds = Micro(Units.Seconds).
open fun <U : Unit<U>?> Micro(@NonNull baseUnit: Unit<U>, @NonNull name: String, @NonNull symbol: String): U
Creates a unit equal to a millionth of the base unit, eg Microseconds = Micro(Units.Seconds, "Microseconds", 'us").
Link copied to clipboard
open fun <U : Unit<U>?> Milli(@NonNull baseUnit: Unit<U>): U
open fun <U : Unit<U>?> Milli(@NonNull baseUnit: Unit<U>, @NonNull name: String, @NonNull symbol: String): U
Creates a unit equal to a thousandth of the base unit, eg Milliseconds = Milli(Units.Seconds).