Package com.ctre.phoenix.motorcontrol
Enum NeutralMode
- All Implemented Interfaces:
Serializable
,Comparable<NeutralMode>
,java.lang.constant.Constable
public enum NeutralMode extends Enum<NeutralMode>
Choose the neutral mode for a motor controller
-
Nested Class Summary
-
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 type with the specified name.static NeutralMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
EEPROMSetting
Use the NeutralMode that is set in the MC's persistent storage. -
Coast
When commanded to neutral, motor leads are set to high-impedance, allowing mechanism to coast. -
Brake
When commanded to neutral, motor leads are commonized electrically to reduce motion.
-
-
Field Details
-
value
Value of NeutralMode
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified nameNullPointerException
- if the argument is null
-