Package frc.robot.subsystems.intake.arm

Enum Class Arm.Goal

java.lang.Object

java.lang.Enum<Arm.Goal>

frc.robot.subsystems.intake.arm.Arm.Goal

All Implemented Interfaces:

Serializable, Comparable<Arm.Goal>, Constable

Enclosing class:

Arm

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

High-level goals for the intake arm.

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
DEPLOY	Deploy the arm for intaking.
RETRACT	Retract the arm inside the robot perimeter.
UNKNOWN	Goal state when the current position hasn't been determined yet.

Method Summary

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

RETRACT

public static final Arm.Goal RETRACT

Retract the arm inside the robot perimeter.

UNKNOWN

public static final Arm.Goal UNKNOWN

Goal state when the current position hasn't been determined yet.

DEPLOY

public static final Arm.Goal DEPLOY

Deploy the arm for intaking.

Method Details

values

public static Arm.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 Arm.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