Package frc.robot.subsystems.climb

Enum Class Climb.Goal

java.lang.Object

java.lang.Enum<Climb.Goal>

frc.robot.subsystems.climb.Climb.Goal

All Implemented Interfaces:

Serializable, Comparable<Climb.Goal>, Constable

Enclosing class:

Climb

public static enum Climb.Goal
extends Enum<Climb.Goal>

High-level goals for the climb subsystem.

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
DOWN	Retract the climber downwards.
STOP	Stop the climb motor.
UP	Extend the climber upwards.

Method Summary

Modifier and Type	Method	Description
static Climb.Goal	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Climb.Goal[]	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

STOP

public static final Climb.Goal STOP

Stop the climb motor.

UP

public static final Climb.Goal UP

Extend the climber upwards.

DOWN

public static final Climb.Goal DOWN

Retract the climber downwards.

Method Details

values

public static Climb.Goal[] 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 Climb.Goal 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