Package com.reduxrobotics.sensors.canandmag

Record Class Canandmag.Status

java.lang.Object

java.lang.Record

com.reduxrobotics.sensors.canandmag.Canandmag.Status

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

Enclosing class:

Canandmag

public static record Canandmag.Status(Canandmag.Faults activeFaults, Canandmag.Faults stickyFaults, double temperature, boolean magnetInRange)
extends Record

Container record class representing a Canandmag's status.

Constructor Summary

Constructors

Constructor	Description
Status(Canandmag.Faults activeFaults, Canandmag.Faults stickyFaults, double temperature, boolean magnetInRange)	Creates an instance of a Status record class.

Method Summary

Modifier and Type	Method	Description
Canandmag.Faults	activeFaults()	Returns the value of the activeFaults 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	magnetInRange()	Returns the value of the magnetInRange record component.
Canandmag.Faults	stickyFaults()	Returns the value of the stickyFaults record component.
double	temperature()	Returns the value of the temperature record component.
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

Status

public Status(Canandmag.Faults activeFaults,
 Canandmag.Faults stickyFaults,
 double temperature,
 boolean magnetInRange)

Creates an instance of a Status 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

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 Canandmag.Faults activeFaults()

Returns the value of the activeFaults record component.

Returns:

the value of the activeFaults record component

stickyFaults

public Canandmag.Faults 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