Record Class ServoHubLowLevel.PeriodicStatus1

java.lang.Object

java.lang.Record

com.revrobotics.servohub.ServoHubLowLevel.PeriodicStatus1

All Implemented Interfaces:

StatusFrame

Enclosing class:

ServoHubLowLevel

public static record ServoHubLowLevel.PeriodicStatus1(boolean regulatorPowerGoodFault, boolean brownout, boolean canWarning, boolean canBusOff, boolean hardwareFault, boolean firmwareFault, boolean hasReset, boolean lowBatteryFault, boolean channel0Overcurrent, boolean channel1Overcurrent, boolean channel2Overcurrent, boolean channel3Overcurrent, boolean channel4Overcurrent, boolean channel5Overcurrent, boolean stickyRegulatorPowerGoodFault, boolean stickyBrownout, boolean stickyCanWarning, boolean stickyCanBusOff, boolean stickyHardwareFault, boolean stickyFirmwareFault, boolean stickyHasReset, boolean stickyLowBatteryFault, boolean stickyChannel0Overcurrent, boolean stickyChannel1Overcurrent, boolean stickyChannel2Overcurrent, boolean stickyChannel3Overcurrent, boolean stickyChannel4Overcurrent, boolean stickyChannel5Overcurrent, int revlibError, long timestamp)
extends Record
implements StatusFrame

Constructor Summary

Constructors

Constructor

Description

PeriodicStatus1(boolean regulatorPowerGoodFault, boolean brownout, boolean canWarning, boolean canBusOff, boolean hardwareFault, boolean firmwareFault, boolean hasReset, boolean lowBatteryFault, boolean channel0Overcurrent, boolean channel1Overcurrent, boolean channel2Overcurrent, boolean channel3Overcurrent, boolean channel4Overcurrent, boolean channel5Overcurrent, boolean stickyRegulatorPowerGoodFault, boolean stickyBrownout, boolean stickyCanWarning, boolean stickyCanBusOff, boolean stickyHardwareFault, boolean stickyFirmwareFault, boolean stickyHasReset, boolean stickyLowBatteryFault, boolean stickyChannel0Overcurrent, boolean stickyChannel1Overcurrent, boolean stickyChannel2Overcurrent, boolean stickyChannel3Overcurrent, boolean stickyChannel4Overcurrent, boolean stickyChannel5Overcurrent, int revlibError, long timestamp)

Creates an instance of a PeriodicStatus1 record class.

Method Summary

Modifier and Type	Method	Description
boolean	brownout()	Returns the value of the brownout record component.
boolean	canBusOff()	Returns the value of the canBusOff record component.
boolean	canWarning()	Returns the value of the canWarning record component.
boolean	channel0Overcurrent()	Returns the value of the channel0Overcurrent record component.
boolean	channel1Overcurrent()	Returns the value of the channel1Overcurrent record component.
boolean	channel2Overcurrent()	Returns the value of the channel2Overcurrent record component.
boolean	channel3Overcurrent()	Returns the value of the channel3Overcurrent record component.
boolean	channel4Overcurrent()	Returns the value of the channel4Overcurrent record component.
boolean	channel5Overcurrent()	Returns the value of the channel5Overcurrent record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
boolean	firmwareFault()	Returns the value of the firmwareFault record component.
boolean	hardwareFault()	Returns the value of the hardwareFault record component.
final int	hashCode()	Returns a hash code value for this object.
boolean	hasReset()	Returns the value of the hasReset record component.
boolean	lowBatteryFault()	Returns the value of the lowBatteryFault record component.
boolean	regulatorPowerGoodFault()	Returns the value of the regulatorPowerGoodFault record component.
int	revlibError()	Returns the value of the revlibError record component.
boolean	stickyBrownout()	Returns the value of the stickyBrownout record component.
boolean	stickyCanBusOff()	Returns the value of the stickyCanBusOff record component.
boolean	stickyCanWarning()	Returns the value of the stickyCanWarning record component.
boolean	stickyChannel0Overcurrent()	Returns the value of the stickyChannel0Overcurrent record component.
boolean	stickyChannel1Overcurrent()	Returns the value of the stickyChannel1Overcurrent record component.
boolean	stickyChannel2Overcurrent()	Returns the value of the stickyChannel2Overcurrent record component.
boolean	stickyChannel3Overcurrent()	Returns the value of the stickyChannel3Overcurrent record component.
boolean	stickyChannel4Overcurrent()	Returns the value of the stickyChannel4Overcurrent record component.
boolean	stickyChannel5Overcurrent()	Returns the value of the stickyChannel5Overcurrent record component.
boolean	stickyFirmwareFault()	Returns the value of the stickyFirmwareFault record component.
boolean	stickyHardwareFault()	Returns the value of the stickyHardwareFault record component.
boolean	stickyHasReset()	Returns the value of the stickyHasReset record component.
boolean	stickyLowBatteryFault()	Returns the value of the stickyLowBatteryFault record component.
boolean	stickyRegulatorPowerGoodFault()	Returns the value of the stickyRegulatorPowerGoodFault record component.
long	timestamp()	Returns the value of the timestamp record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Methods inherited from interface StatusFrame

getRevlibError

Constructor Details

PeriodicStatus1

public PeriodicStatus1(boolean regulatorPowerGoodFault,
 boolean brownout,
 boolean canWarning,
 boolean canBusOff,
 boolean hardwareFault,
 boolean firmwareFault,
 boolean hasReset,
 boolean lowBatteryFault,
 boolean channel0Overcurrent,
 boolean channel1Overcurrent,
 boolean channel2Overcurrent,
 boolean channel3Overcurrent,
 boolean channel4Overcurrent,
 boolean channel5Overcurrent,
 boolean stickyRegulatorPowerGoodFault,
 boolean stickyBrownout,
 boolean stickyCanWarning,
 boolean stickyCanBusOff,
 boolean stickyHardwareFault,
 boolean stickyFirmwareFault,
 boolean stickyHasReset,
 boolean stickyLowBatteryFault,
 boolean stickyChannel0Overcurrent,
 boolean stickyChannel1Overcurrent,
 boolean stickyChannel2Overcurrent,
 boolean stickyChannel3Overcurrent,
 boolean stickyChannel4Overcurrent,
 boolean stickyChannel5Overcurrent,
 int revlibError,
 long timestamp)

Creates an instance of a PeriodicStatus1 record class.

Parameters:

regulatorPowerGoodFault - the value for the regulatorPowerGoodFault record component

brownout - the value for the brownout record component

canWarning - the value for the canWarning record component

canBusOff - the value for the canBusOff record component

hardwareFault - the value for the hardwareFault record component

firmwareFault - the value for the firmwareFault record component

hasReset - the value for the hasReset record component

lowBatteryFault - the value for the lowBatteryFault record component

channel0Overcurrent - the value for the channel0Overcurrent record component

channel1Overcurrent - the value for the channel1Overcurrent record component

channel2Overcurrent - the value for the channel2Overcurrent record component

channel3Overcurrent - the value for the channel3Overcurrent record component

channel4Overcurrent - the value for the channel4Overcurrent record component

channel5Overcurrent - the value for the channel5Overcurrent record component

stickyRegulatorPowerGoodFault - the value for the stickyRegulatorPowerGoodFault record component

stickyBrownout - the value for the stickyBrownout record component

stickyCanWarning - the value for the stickyCanWarning record component

stickyCanBusOff - the value for the stickyCanBusOff record component

stickyHardwareFault - the value for the stickyHardwareFault record component

stickyFirmwareFault - the value for the stickyFirmwareFault record component

stickyHasReset - the value for the stickyHasReset record component

stickyLowBatteryFault - the value for the stickyLowBatteryFault record component

stickyChannel0Overcurrent - the value for the stickyChannel0Overcurrent record component

stickyChannel1Overcurrent - the value for the stickyChannel1Overcurrent record component

stickyChannel2Overcurrent - the value for the stickyChannel2Overcurrent record component

stickyChannel3Overcurrent - the value for the stickyChannel3Overcurrent record component

stickyChannel4Overcurrent - the value for the stickyChannel4Overcurrent record component

stickyChannel5Overcurrent - the value for the stickyChannel5Overcurrent record component

revlibError - the value for the revlibError record component

timestamp - the value for the timestamp 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. All components in this record class are compared with the compare method from their corresponding wrapper classes.

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.

regulatorPowerGoodFault

public boolean regulatorPowerGoodFault()

Returns the value of the regulatorPowerGoodFault record component.

Returns:

the value of the regulatorPowerGoodFault record component

brownout

public boolean brownout()

Returns the value of the brownout record component.

Returns:

the value of the brownout record component

canWarning

public boolean canWarning()

Returns the value of the canWarning record component.

Returns:

the value of the canWarning record component

canBusOff

public boolean canBusOff()

Returns the value of the canBusOff record component.

Returns:

the value of the canBusOff record component

hardwareFault

public boolean hardwareFault()

Returns the value of the hardwareFault record component.

Returns:

the value of the hardwareFault record component

firmwareFault

public boolean firmwareFault()

Returns the value of the firmwareFault record component.

Returns:

the value of the firmwareFault record component

hasReset

public boolean hasReset()

Returns the value of the hasReset record component.

Returns:

the value of the hasReset record component

lowBatteryFault

public boolean lowBatteryFault()

Returns the value of the lowBatteryFault record component.

Returns:

the value of the lowBatteryFault record component

channel0Overcurrent

public boolean channel0Overcurrent()

Returns the value of the channel0Overcurrent record component.

Returns:

the value of the channel0Overcurrent record component

channel1Overcurrent

public boolean channel1Overcurrent()

Returns the value of the channel1Overcurrent record component.

Returns:

the value of the channel1Overcurrent record component

channel2Overcurrent

public boolean channel2Overcurrent()

Returns the value of the channel2Overcurrent record component.

Returns:

the value of the channel2Overcurrent record component

channel3Overcurrent

public boolean channel3Overcurrent()

Returns the value of the channel3Overcurrent record component.

Returns:

the value of the channel3Overcurrent record component

channel4Overcurrent

public boolean channel4Overcurrent()

Returns the value of the channel4Overcurrent record component.

Returns:

the value of the channel4Overcurrent record component

channel5Overcurrent

public boolean channel5Overcurrent()

Returns the value of the channel5Overcurrent record component.

Returns:

the value of the channel5Overcurrent record component

stickyRegulatorPowerGoodFault

public boolean stickyRegulatorPowerGoodFault()

Returns the value of the stickyRegulatorPowerGoodFault record component.

Returns:

the value of the stickyRegulatorPowerGoodFault record component

stickyBrownout

public boolean stickyBrownout()

Returns the value of the stickyBrownout record component.

Returns:

the value of the stickyBrownout record component

stickyCanWarning

public boolean stickyCanWarning()

Returns the value of the stickyCanWarning record component.

Returns:

the value of the stickyCanWarning record component

stickyCanBusOff

public boolean stickyCanBusOff()

Returns the value of the stickyCanBusOff record component.

Returns:

the value of the stickyCanBusOff record component

stickyHardwareFault

public boolean stickyHardwareFault()

Returns the value of the stickyHardwareFault record component.

Returns:

the value of the stickyHardwareFault record component

stickyFirmwareFault

public boolean stickyFirmwareFault()

Returns the value of the stickyFirmwareFault record component.

Returns:

the value of the stickyFirmwareFault record component

stickyHasReset

public boolean stickyHasReset()

Returns the value of the stickyHasReset record component.

Returns:

the value of the stickyHasReset record component

stickyLowBatteryFault

public boolean stickyLowBatteryFault()

Returns the value of the stickyLowBatteryFault record component.

Returns:

the value of the stickyLowBatteryFault record component

stickyChannel0Overcurrent

public boolean stickyChannel0Overcurrent()

Returns the value of the stickyChannel0Overcurrent record component.

Returns:

the value of the stickyChannel0Overcurrent record component

stickyChannel1Overcurrent

public boolean stickyChannel1Overcurrent()

Returns the value of the stickyChannel1Overcurrent record component.

Returns:

the value of the stickyChannel1Overcurrent record component

stickyChannel2Overcurrent

public boolean stickyChannel2Overcurrent()

Returns the value of the stickyChannel2Overcurrent record component.

Returns:

the value of the stickyChannel2Overcurrent record component

stickyChannel3Overcurrent

public boolean stickyChannel3Overcurrent()

Returns the value of the stickyChannel3Overcurrent record component.

Returns:

the value of the stickyChannel3Overcurrent record component

stickyChannel4Overcurrent

public boolean stickyChannel4Overcurrent()

Returns the value of the stickyChannel4Overcurrent record component.

Returns:

the value of the stickyChannel4Overcurrent record component

stickyChannel5Overcurrent

public boolean stickyChannel5Overcurrent()

Returns the value of the stickyChannel5Overcurrent record component.

Returns:

the value of the stickyChannel5Overcurrent record component

revlibError

public int revlibError()

Returns the value of the revlibError record component.

Specified by:

revlibError in interface StatusFrame

Returns:

the value of the revlibError record component

timestamp

public long timestamp()

Returns the value of the timestamp record component.

Specified by:

timestamp in interface StatusFrame

Returns:

the value of the timestamp record component