Package com.stuypulse.robot.subsystems.handoff

Enum Class Handoff.HandoffState

java.lang.Object

java.lang.Enum<Handoff.HandoffState>

com.stuypulse.robot.subsystems.handoff.Handoff.HandoffState

All Implemented Interfaces:

Serializable, Comparable<Handoff.HandoffState>, Constable

Enclosing class:

Handoff

public static enum Handoff.HandoffState
extends Enum<Handoff.HandoffState>

Enum representing the different possible states of the handoff.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FORWARD	The handoff runs forward.
IDLE	Handoff is stopped.
REVERSE	The handoff runs backward.

Field Summary

Fields

Modifier and Type	Field	Description
private edu.wpi.first.units.measure.Voltage	targetVoltage	The target voltage of the handoff motor.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	HandoffState(edu.wpi.first.units.measure.Voltage targetVoltage)	Constructs a HandoffState with the given target voltage.

Method Summary

Modifier and Type	Method	Description
edu.wpi.first.units.measure.Voltage	getTargetVoltage()	Gets the target voltage of the handoff motor in the corresponding state.
static Handoff.HandoffState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Handoff.HandoffState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IDLE

public static final Handoff.HandoffState IDLE

Handoff is stopped.

FORWARD

public static final Handoff.HandoffState FORWARD

The handoff runs forward.

REVERSE

public static final Handoff.HandoffState REVERSE

The handoff runs backward.

Field Details

targetVoltage

private edu.wpi.first.units.measure.Voltage targetVoltage

The target voltage of the handoff motor.

Constructor Details

HandoffState

private HandoffState(edu.wpi.first.units.measure.Voltage targetVoltage)

Constructs a HandoffState with the given target voltage.

Parameters:

targetVoltage - the target voltage of the handoff motor in the corresponding state.

Method Details

values

public static Handoff.HandoffState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Handoff.HandoffState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getTargetVoltage

public edu.wpi.first.units.measure.Voltage getTargetVoltage()

Gets the target voltage of the handoff motor in the corresponding state.

Returns:

the target voltage of the handoff motor