Enum Class RobotMode

java.lang.Object

java.lang.Enum<RobotMode>

org.wpilib.hardware.hal.RobotMode

All Implemented Interfaces:

Serializable, Comparable<RobotMode>, Constable

public enum RobotMode
extends Enum<RobotMode>

Robot mode. Note this does not indicate enabled state.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTONOMOUS	Autonomous.
TELEOPERATED	Teleoperated.
UNKNOWN	Unknown.
UTILITY	Utility.

Method Summary

Modifier and Type	Method	Description
static RobotMode	fromInt(int value)	Gets a mode from an integer value.
int	getValue()	Gets the integer value for the mode.
static RobotMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RobotMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final RobotMode UNKNOWN

Unknown.

AUTONOMOUS

public static final RobotMode AUTONOMOUS

Autonomous.

TELEOPERATED

public static final RobotMode TELEOPERATED

Teleoperated.

UTILITY

public static final RobotMode UTILITY

Utility.

Method Details

values

public static RobotMode[] 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 RobotMode 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

getValue

public int getValue()

Gets the integer value for the mode.

Returns:

value

fromInt

public static RobotMode fromInt(int value)

Gets a mode from an integer value.