Enum Class MassUnits

java.lang.Object
java.lang.Enum<MassUnits>
tagalong.units.MassUnits
All Implemented Interfaces:
Serializable, Comparable<MassUnits>, Constable

public enum MassUnits extends Enum<MassUnits>
Mass units enum identifiers. Used for configuration and robot setup instead of the WPILib Java units to avoid reallocations and garbage collections in match.
  • Enum Constant Details

  • Field Details

    • conversionToKgs

      public final double conversionToKgs
      Kilograms per unit (conversion l.t. 1 if less than a kilogram)
  • Method Details

    • values

      public static MassUnits[] 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

      public static MassUnits valueOf(String name)
      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 name
      NullPointerException - if the argument is null
    • convertX

      public double convertX(double x, MassUnits targetUnit)
      Convert from the base unit to the given argument unit
      Parameters:
      x - double to be converted
      targetUnit - target unit
      Returns:
      x converted to the target units