Package edu.wpi.first.wpilibj

Enum Class GenericHID.RumbleType

java.lang.Object

java.lang.Enum<GenericHID.RumbleType>

edu.wpi.first.wpilibj.GenericHID.RumbleType

All Implemented Interfaces:

Serializable, Comparable<GenericHID.RumbleType>, Constable

Enclosing class:

GenericHID

public static enum GenericHID.RumbleType
extends Enum<GenericHID.RumbleType>

Represents a rumble output on the Joystick.

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
kBothRumble	Both left and right rumble motors.
kLeftRumble	Left rumble motor.
kRightRumble	Right rumble motor.

Method Summary

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

kLeftRumble

public static final GenericHID.RumbleType kLeftRumble

Left rumble motor.

kRightRumble

public static final GenericHID.RumbleType kRightRumble

Right rumble motor.

kBothRumble

public static final GenericHID.RumbleType kBothRumble

Both left and right rumble motors.

Method Details

values

public static GenericHID.RumbleType[] 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 GenericHID.RumbleType 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