Package com.reduxrobotics.sensors.canandgyro

Record Class CanandgyroStatus

java.lang.Object
java.lang.Record
com.reduxrobotics.sensors.canandgyro.CanandgyroStatus
Record Components:
activeFaults - the active faults of the device.
stickyFaults - the sticky faults of the device.
temperature - the temperature of the device's processor, in deg Celsius.
All Implemented Interfaces:
StructSerializable, WPISerializable
public record CanandgyroStatus(boolean valid, CanandgyroFaults activeFaults, CanandgyroFaults stickyFaults, double temperature) extends Record implements StructSerializable
Container record class representing a Canandgyro's status.

  • Field Details

    • struct

      public static final CanandgyroStatusStruct struct
      This field is necessary for WPILib structs to work around Java type erasure.

  • Constructor Details

    • CanandgyroStatus

      public CanandgyroStatus(boolean valid, CanandgyroFaults activeFaults, CanandgyroFaults stickyFaults, double temperature)
      Creates an instance of a CanandgyroStatus record class.
      Parameters:
      valid - the value for the valid record component
      activeFaults - the value for the activeFaults record component
      stickyFaults - the value for the stickyFaults record component
      temperature - the value for the temperature record component

  • Method Details

    • invalid

      public static CanandgyroStatus invalid()
      Returns a default Status record for frame initializion
      Returns:
      invalid Status record

    • fromByteArray

      public static CanandgyroStatus fromByteArray(byte[] v)
      Deserializes a Status object from a byte array.
      Parameters:
      v - byte array to deserialize from
      Returns:
      new Status

    • fromLong

      public static CanandgyroStatus fromLong(long v)
      Deserializes a Status object from a long.
      Parameters:
      v - long data
      Returns:
      new Status

    • 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.

    • valid

      public boolean valid()
      Returns the value of the valid record component.
      Returns:
      the value of the valid record component

    • activeFaults

      public CanandgyroFaults activeFaults()
      Returns the value of the activeFaults record component.
      Returns:
      the value of the activeFaults record component

    • stickyFaults

      public CanandgyroFaults stickyFaults()
      Returns the value of the stickyFaults record component.
      Returns:
      the value of the stickyFaults record component

    • temperature

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