Package com.reduxrobotics.sensors.canandmag

Record Class CanandmagStatus

java.lang.Object
java.lang.Record
com.reduxrobotics.sensors.canandmag.CanandmagStatus
Record Components:
activeFaults - the active faults of the encoder.
stickyFaults - the sticky faults of the encoder.
temperature - the temperature of the encoder's processor, in deg Celsius.
magnetInRange - whether the encoder's magnet is in range
All Implemented Interfaces:
StructSerializable, WPISerializable
public record CanandmagStatus(CanandmagFaults activeFaults, CanandmagFaults stickyFaults, double temperature, boolean magnetInRange) extends Record implements StructSerializable
Container record class representing a Canandmag's status.

  • Field Details

    • struct

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

  • Constructor Details

    • CanandmagStatus

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

  • Method Details

    • invalid

      public static CanandmagStatus invalid()
      Return an invalid Status.
      Returns:
      an invalid/default status

    • fromByteArray

      public static CanandmagStatus fromByteArray(byte[] v)
      Deserializes a Status object from a byte array.
      Parameters:
      v - byte array to deserialize from
      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.

    • activeFaults

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

    • stickyFaults

      public CanandmagFaults 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

    • magnetInRange

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