Enum Class Gamepad.Axis

java.lang.Object

java.lang.Enum<Gamepad.Axis>

org.wpilib.driverstation.Gamepad.Axis

All Implemented Interfaces:

Serializable, Comparable<Gamepad.Axis>, Constable

Enclosing class:

Gamepad

public static enum Gamepad.Axis
extends Enum<Gamepad.Axis>

Represents an axis on an Gamepad.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LEFT_TRIGGER	Left trigger.
LEFT_X	Left X axis.
LEFT_Y	Left Y axis.
RIGHT_TRIGGER	Right trigger.
RIGHT_X	Right X axis.
RIGHT_Y	Right Y axis.

Field Summary

Fields

Modifier and Type	Field	Description
final int	value	Axis value.

Method Summary

Modifier and Type	Method	Description
String	toString()	Get the human-friendly name of the axis, matching the relevant methods.
static Gamepad.Axis	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Gamepad.Axis[]	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, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LEFT_X

public static final Gamepad.Axis LEFT_X

Left X axis.

LEFT_Y

public static final Gamepad.Axis LEFT_Y

Left Y axis.

RIGHT_X

public static final Gamepad.Axis RIGHT_X

Right X axis.

RIGHT_Y

public static final Gamepad.Axis RIGHT_Y

Right Y axis.

LEFT_TRIGGER

public static final Gamepad.Axis LEFT_TRIGGER

Left trigger.

RIGHT_TRIGGER

public static final Gamepad.Axis RIGHT_TRIGGER

Right trigger.

Field Details

value

public final int value

Axis value.

Method Details

values

public static Gamepad.Axis[] 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 Gamepad.Axis 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

toString

public String toString()

Get the human-friendly name of the axis, matching the relevant methods.

Primarily used for automated unit tests.

Overrides:

toString in class Enum<Gamepad.Axis>

Returns:

the human-friendly name of the axis.