Package com.ctre.phoenix.motorcontrol

Enum Class NeutralMode

java.lang.Object

java.lang.Enum<NeutralMode>

com.ctre.phoenix.motorcontrol.NeutralMode

All Implemented Interfaces:

Serializable, Comparable<NeutralMode>, Constable

public enum NeutralMode
extends Enum<NeutralMode>

Choose the neutral mode for a motor controller

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
Brake	When commanded to neutral, motor leads are commonized electrically to reduce motion.
Coast	When commanded to neutral, motor leads are set to high-impedance, allowing mechanism to coast.
EEPROMSetting	Use the NeutralMode that is set in the MC's persistent storage.

Field Summary

Fields

Modifier and Type	Field	Description
int	value	Value of NeutralMode

Method Summary

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

EEPROMSetting

public static final NeutralMode EEPROMSetting

Use the NeutralMode that is set in the MC's persistent storage.

Coast

public static final NeutralMode Coast

When commanded to neutral, motor leads are set to high-impedance, allowing mechanism to coast.

Brake

public static final NeutralMode Brake

When commanded to neutral, motor leads are commonized electrically to reduce motion.

Field Details

value

public int value

Value of NeutralMode

Method Details

values

public static 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 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