Package frc.robot.shotdata

Record Class ShotData.ShotParameters

java.lang.Object

java.lang.Record

frc.robot.shotdata.ShotData.ShotParameters

Record Components:

desiredSpeed - target flywheel speed in rotations per second

hoodAngleDeg - hood angle in degrees

timeOfFlight - estimated time of flight in seconds

isOkayToShoot - whether the flywheel is spun up sufficiently to shoot

Enclosing class:

ShotData

public static record ShotData.ShotParameters(double desiredSpeed, double hoodAngleDeg, double timeOfFlight, boolean isOkayToShoot)
extends Record

Encapsulates the computed shooter parameters for a single shot instance.

Constructor Summary

Constructors

Constructor	Description
ShotParameters(double desiredSpeed, double hoodAngleDeg, double timeOfFlight, boolean isOkayToShoot)	Creates an instance of a ShotParameters record class.

Method Summary

Modifier and Type	Method	Description
double	desiredSpeed()	Returns the value of the desiredSpeed 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.
double	hoodAngleDeg()	Returns the value of the hoodAngleDeg record component.
boolean	isOkayToShoot()	Returns the value of the isOkayToShoot record component.
double	timeOfFlight()	Returns the value of the timeOfFlight 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

ShotParameters

public ShotParameters(double desiredSpeed,
 double hoodAngleDeg,
 double timeOfFlight,
 boolean isOkayToShoot)

Creates an instance of a ShotParameters record class.

Parameters:

desiredSpeed - the value for the desiredSpeed record component

hoodAngleDeg - the value for the hoodAngleDeg record component

timeOfFlight - the value for the timeOfFlight record component

isOkayToShoot - the value for the isOkayToShoot 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 '=='.

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.

desiredSpeed

public double desiredSpeed()

Returns the value of the desiredSpeed record component.

Returns:

the value of the desiredSpeed record component

hoodAngleDeg

public double hoodAngleDeg()

Returns the value of the hoodAngleDeg record component.

Returns:

the value of the hoodAngleDeg record component

timeOfFlight

public double timeOfFlight()

Returns the value of the timeOfFlight record component.

Returns:

the value of the timeOfFlight record component

isOkayToShoot

public boolean isOkayToShoot()

Returns the value of the isOkayToShoot record component.

Returns:

the value of the isOkayToShoot record component