Package tagalong.units
Enum Class MassUnits
- All Implemented Interfaces:
Serializable
,Comparable<MassUnits>
,Constable
Mass units enum identifiers.
Used for configuration and robot setup instead of the WPILib Java units to
avoid reallocations and garbage collections in match.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Field Summary
FieldsModifier and TypeFieldDescriptionfinal double
Kilograms per unit (conversion l.t. -
Method Summary
Modifier and TypeMethodDescriptiondouble
Convert from the base unit to the given argument unitstatic MassUnits
Returns the enum constant of this class with the specified name.static MassUnits[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
GRAMS
Grams -
KILOGRAMS
Kilograms -
POUNDS
Pounds -
OUNCES
Ounces
-
-
Field Details
-
conversionToKgs
Kilograms per unit (conversion l.t. 1 if less than a kilogram)
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
convertX
Convert from the base unit to the given argument unit- Parameters:
x
- double to be convertedtargetUnit
- target unit- Returns:
- x converted to the target units
-