Record Class ShotGate.Decision

java.lang.Object

java.lang.Record

frc.robot.subsystems.ShotGate.Decision

Record Components:

ready - every start check passes right now (what the driver waits for; also shown while tracking, before the trigger is pulled)

feed - fuel may go into the flywheel this loop

reason - why it may or may not

blocker - what is holding the feed (ShotGate.Blocker.NONE while a volley is open). When the override or timeout feeds, this is what they bypass. Not launching, this is what would hold a volley that started now

secondsHeld - how long this launch has been held so far, 0 while feeding

Enclosing class:

ShotGate

public static record ShotGate.Decision(boolean ready, boolean feed, ShotGate.FeedReason reason, ShotGate.Blocker blocker, double secondsHeld)
extends Record

The gate's answer for one loop.

Field Summary

Fields

Modifier and Type	Field	Description
static final ShotGate.Decision	IDLE

Constructor Summary

Constructors

Constructor	Description
Decision(boolean ready, boolean feed, ShotGate.FeedReason reason, ShotGate.Blocker blocker, double secondsHeld)	Creates an instance of a Decision record class.

Method Summary

Modifier and Type	Method	Description
ShotGate.Blocker	blocker()	Returns the value of the blocker record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
boolean	feed()	Returns the value of the feed record component.
final int	hashCode()	Returns a hash code value for this object.
boolean	ready()	Returns the value of the ready record component.
ShotGate.FeedReason	reason()	Returns the value of the reason record component.
double	secondsHeld()	Returns the value of the secondsHeld 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

Field Details

IDLE

public static final ShotGate.Decision IDLE

Constructor Details

Decision

public Decision(boolean ready,
 boolean feed,
 ShotGate.FeedReason reason,
 ShotGate.Blocker blocker,
 double secondsHeld)

Creates an instance of a Decision record class.

Parameters:

ready - the value for the ready record component

feed - the value for the feed record component

reason - the value for the reason record component

blocker - the value for the blocker record component

secondsHeld - the value for the secondsHeld 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 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.

ready

public boolean ready()

Returns the value of the ready record component.

Returns:

the value of the ready record component

feed

public boolean feed()

Returns the value of the feed record component.

Returns:

the value of the feed record component

reason

public ShotGate.FeedReason reason()

Returns the value of the reason record component.

Returns:

the value of the reason record component

blocker

public ShotGate.Blocker blocker()

Returns the value of the blocker record component.

Returns:

the value of the blocker record component

secondsHeld

public double secondsHeld()

Returns the value of the secondsHeld record component.

Returns:

the value of the secondsHeld record component