Enum Class ExpansionHubMotor.NeutralMode

java.lang.Object

java.lang.Enum<ExpansionHubMotor.NeutralMode>

org.wpilib.hardware.expansionhub.ExpansionHubMotor.NeutralMode

All Implemented Interfaces:

Serializable, Comparable<ExpansionHubMotor.NeutralMode>, Constable

Enclosing class:

ExpansionHubMotor

public static enum ExpansionHubMotor.NeutralMode
extends Enum<ExpansionHubMotor.NeutralMode>

Neutral mode applied when the motor output is commanded to 0.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BRAKE	Actively brake the motor when output is zero.
COAST	Allow the motor to coast when output is zero.

Method Summary

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

COAST

public static final ExpansionHubMotor.NeutralMode COAST

Allow the motor to coast when output is zero.

BRAKE

public static final ExpansionHubMotor.NeutralMode BRAKE

Actively brake the motor when output is zero.

Method Details

values

public static ExpansionHubMotor.NeutralMode[] 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 ExpansionHubMotor.NeutralMode 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