Package com.titaniumtigers4829.data.imu

Record Class IMUData

java.lang.Object
java.lang.Record
com.titaniumtigers4829.data.imu.IMUData
public record IMUData(double robotYaw, double roll, double pitch, double yaw, double gyroX, double gyroY, double gyroZ, double accelX, double accelY, double accelZ, IMUData.IMUMode imuMode) extends Record
Encapsulates the state of an internal Limelight IMU. This includes gyro and accelerometer data.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    IMUData.IMUMode
    Enum representing different IMU usage modes for robot orientation or localization.

  • Constructor Summary

    Constructors
    Constructor
    Description
    IMUData()
    Initializes an "empty" IMUData record with default values
    IMUData(double robotYaw, double roll, double pitch, double yaw, double gyroX, double gyroY, double gyroZ, double accelX, double accelY, double accelZ, IMUData.IMUMode imuMode)
    Creates an instance of a IMUData record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    accelX()
    Returns the value of the accelX record component.
    double
    accelY()
    Returns the value of the accelY record component.
    double
    accelZ()
    Returns the value of the accelZ record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    double
    gyroX()
    Returns the value of the gyroX record component.
    double
    gyroY()
    Returns the value of the gyroY record component.
    double
    gyroZ()
    Returns the value of the gyroZ record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    IMUData.IMUMode
    imuMode()
    Returns the value of the imuMode record component.
    double
    pitch()
    Returns the value of the pitch record component.
    double
    robotYaw()
    Returns the value of the robotYaw record component.
    double
    roll()
    Returns the value of the roll record component.
    final String
    toString()
    Returns a string representation of this record class.
    double
    yaw()
    Returns the value of the yaw record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • IMUData

      public IMUData()
      Initializes an "empty" IMUData record with default values

    • IMUData

      public IMUData(double robotYaw, double roll, double pitch, double yaw, double gyroX, double gyroY, double gyroZ, double accelX, double accelY, double accelZ, IMUData.IMUMode imuMode)
      Creates an instance of a IMUData record class.
      Parameters:
      robotYaw - the value for the robotYaw record component
      roll - the value for the roll record component
      pitch - the value for the pitch record component
      yaw - the value for the yaw record component
      gyroX - the value for the gyroX record component
      gyroY - the value for the gyroY record component
      gyroZ - the value for the gyroZ record component
      accelX - the value for the accelX record component
      accelY - the value for the accelY record component
      accelZ - the value for the accelZ record component
      imuMode - the value for the imuMode record component

  • Method Details

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • robotYaw

      public double robotYaw()
      Returns the value of the robotYaw record component.
      Returns:
      the value of the robotYaw record component

    • roll

      public double roll()
      Returns the value of the roll record component.
      Returns:
      the value of the roll record component

    • pitch

      public double pitch()
      Returns the value of the pitch record component.
      Returns:
      the value of the pitch record component

    • yaw

      public double yaw()
      Returns the value of the yaw record component.
      Returns:
      the value of the yaw record component

    • gyroX

      public double gyroX()
      Returns the value of the gyroX record component.
      Returns:
      the value of the gyroX record component

    • gyroY

      public double gyroY()
      Returns the value of the gyroY record component.
      Returns:
      the value of the gyroY record component

    • gyroZ

      public double gyroZ()
      Returns the value of the gyroZ record component.
      Returns:
      the value of the gyroZ record component

    • accelX

      public double accelX()
      Returns the value of the accelX record component.
      Returns:
      the value of the accelX record component

    • accelY

      public double accelY()
      Returns the value of the accelY record component.
      Returns:
      the value of the accelY record component

    • accelZ

      public double accelZ()
      Returns the value of the accelZ record component.
      Returns:
      the value of the accelZ record component

    • imuMode

      public IMUData.IMUMode imuMode()
      Returns the value of the imuMode record component.
      Returns:
      the value of the imuMode record component