Package com.ctre.phoenix6.signals
Enum Class S2CloseStateValue
- All Implemented Interfaces:
Serializable
,Comparable<S2CloseStateValue>
,java.lang.constant.Constable
What value the Signal 2 input (S2IN) needs to be for the CANdi to detect as
Closed.
Devices using the S2 input as a remote limit switch will treat the switch as closed when the S2 input is this state.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe S2 input will be treated as closed when it is floating.The S2 input will be treated as closed when it is High.The S2 input will be treated as closed when it is Low.The S2 input will be treated as closed when it is not floating.The S2 input will be treated as closed when it is not High.The S2 input will be treated as closed when it is not Low. -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic S2CloseStateValue
valueOf
(int value) Gets S2CloseStateValue from specified valuestatic S2CloseStateValue
Returns the enum constant of this class with the specified name.static S2CloseStateValue[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
CloseWhenNotFloating
The S2 input will be treated as closed when it is not floating. -
CloseWhenFloating
The S2 input will be treated as closed when it is floating. -
CloseWhenNotHigh
The S2 input will be treated as closed when it is not High. -
CloseWhenHigh
The S2 input will be treated as closed when it is High. -
CloseWhenNotLow
The S2 input will be treated as closed when it is not Low. -
CloseWhenLow
The S2 input will be treated as closed when it is Low.
-
-
Field Details
-
value
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
valueOf
Gets S2CloseStateValue from specified value- Parameters:
value
- Value of S2CloseStateValue- Returns:
- S2CloseStateValue of specified value
-