Package tagalong.units

Enum Class DistanceUnits

java.lang.Object
java.lang.Enum<DistanceUnits>
tagalong.units.DistanceUnits
All Implemented Interfaces:
Serializable, Comparable<DistanceUnits>, Constable
public enum DistanceUnits extends Enum<DistanceUnits>
Distance 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

    • isRotational

      public final boolean isRotational
      True if unit measures rotational distance (degree, radians, rotation) False if unit measures linear distance (inch, foot, meter)

    • conversionToBase

      public final double conversionToBase
      If rotational, rotations per unit (conversion l.t. 1 if smaller than a rotation) If linear, meters per unit (conversion l.t. 1 if smaller than a meter)

  • Method Details

    • values

      public static DistanceUnits[] 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 DistanceUnits 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, DistanceUnits targetUnit)
      Parameters:
      x - double to be converted
      targetUnit - target units
      Returns:
      x converted to the target units