Package com.ctre.phoenix6.mechanisms
Enum MechanismState
- All Implemented Interfaces:
Serializable
,Comparable<MechanismState>
,java.lang.constant.Constable
public enum MechanismState extends Enum<MechanismState>
Possible states of a mechanism.
-
Nested Class Summary
-
Enum Constant Summary
Enum Constants Enum Constant Description Disabled
The mechanism is temporarily disabled due to an issue.OK
The mechanism is running normally.RequiresUserAction
The mechanism is disabled and requires user action. -
Method Summary
Modifier and Type Method Description static MechanismState
valueOf(String name)
Returns the enum constant of this type with the specified name.static MechanismState[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
OK
The mechanism is running normally. -
Disabled
The mechanism is temporarily disabled due to an issue. -
RequiresUserAction
The mechanism is disabled and requires user action.
-
-
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
-