Package edu.wpi.first.wpilibj
Enum Class XboxController.Axis
- All Implemented Interfaces:
Serializable
,Comparable<XboxController.Axis>
,Constable
- Enclosing class:
- XboxController
Represents an axis on an XboxController.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionLeft trigger.Left X axis.Left Y axis.Right trigger.Right X axis.Right Y axis. -
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptiontoString()
Get the human-friendly name of the axis, matching the relevant methods.static XboxController.Axis
Returns the enum constant of this class with the specified name.static XboxController.Axis[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
kLeftX
Left X axis. -
kRightX
Right X axis. -
kLeftY
Left Y axis. -
kRightY
Right Y axis. -
kLeftTrigger
Left trigger. -
kRightTrigger
Right trigger.
-
-
Field Details
-
value
Axis value.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
toString
Get the human-friendly name of the axis, matching the relevant methods. This is done by stripping the leading `k`, and appending `Axis` if the name ends with `Trigger`.Primarily used for automated unit tests.
- Overrides:
toString
in classEnum<XboxController.Axis>
- Returns:
- the human-friendly name of the axis.
-