Package frc.robot

Record Class Constants.CoralArmConstants.ArmState

java.lang.Object
java.lang.Record
frc.robot.Constants.CoralArmConstants.ArmState
Enclosing class:
Constants.CoralArmConstants
public static record Constants.CoralArmConstants.ArmState(edu.wpi.first.units.measure.Angle elbowAngle, edu.wpi.first.units.measure.Distance elevatorHeight) extends Record
Represents a specific position state of the arm

  • Constructor Summary

    Constructors
    Constructor
    Description
    ArmState(edu.wpi.first.units.measure.Angle elbowAngle, edu.wpi.first.units.measure.Distance elevatorHeight)
    Creates an instance of a ArmState record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    edu.wpi.first.units.measure.Angle
    elbowAngle()
    Returns the value of the elbowAngle record component.
    edu.wpi.first.units.measure.Distance
    elevatorHeight()
    Returns the value of the elevatorHeight record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isFront()
    Checks if the arm is on the front side.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ArmState

      public ArmState(edu.wpi.first.units.measure.Angle elbowAngle, edu.wpi.first.units.measure.Distance elevatorHeight)
      Creates an instance of a ArmState record class.
      Parameters:
      elbowAngle - the value for the elbowAngle record component
      elevatorHeight - the value for the elevatorHeight record component

  • Method Details

    • isFront

      public boolean isFront()
      Checks if the arm is on the front side.
      Returns:
      True if the arm is on the front side, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • elbowAngle

      public edu.wpi.first.units.measure.Angle elbowAngle()
      Returns the value of the elbowAngle record component.
      Returns:
      the value of the elbowAngle record component

    • elevatorHeight

      public edu.wpi.first.units.measure.Distance elevatorHeight()
      Returns the value of the elevatorHeight record component.
      Returns:
      the value of the elevatorHeight record component