Enum Class S2CloseStateValue

java.lang.Object
java.lang.Enum<S2CloseStateValue>
com.ctre.phoenix6.signals.S2CloseStateValue
All Implemented Interfaces:
Serializable, Comparable<S2CloseStateValue>, Constable
public enum S2CloseStateValue extends Enum<S2CloseStateValue>
What value the Signal 2 input (S2IN) needs to be for the CTR Electronics' 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.

  • Enum Constant Details

    • CloseWhenNotFloating

      public static final S2CloseStateValue CloseWhenNotFloating
      The S2 input will be treated as closed when it is not floating.

    • CloseWhenFloating

      public static final S2CloseStateValue CloseWhenFloating
      The S2 input will be treated as closed when it is floating.

    • CloseWhenNotHigh

      public static final S2CloseStateValue CloseWhenNotHigh
      The S2 input will be treated as closed when it is not High.

    • CloseWhenHigh

      public static final S2CloseStateValue CloseWhenHigh
      The S2 input will be treated as closed when it is High.

    • CloseWhenNotLow

      public static final S2CloseStateValue CloseWhenNotLow
      The S2 input will be treated as closed when it is not Low.

    • CloseWhenLow

      public static final S2CloseStateValue CloseWhenLow
      The S2 input will be treated as closed when it is Low.

  • Field Details

    • value

      public final int value
      Unique integer value of this S2CloseStateValue.

  • Method Details

    • values

      public static S2CloseStateValue[] 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 S2CloseStateValue 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

    • valueOf

      public static S2CloseStateValue valueOf(int value)
      Gets S2CloseStateValue from specified value
      Parameters:
      value - Value of S2CloseStateValue
      Returns:
      S2CloseStateValue of specified value