Enum Class UpdateModeValue

java.lang.Object
java.lang.Enum<UpdateModeValue>
com.ctre.phoenix6.signals.UpdateModeValue
All Implemented Interfaces:
Serializable, Comparable<UpdateModeValue>, java.lang.constant.Constable

public enum UpdateModeValue extends Enum<UpdateModeValue>
Update mode of the CANrange. The CANrange supports short-range and long-range detection at various update frequencies.
  • Enum Constant Details

    • ShortRange100Hz

      public static final UpdateModeValue ShortRange100Hz
      Updates distance/proximity at 100hz using short-range detection mode.
    • ShortRangeUserFreq

      public static final UpdateModeValue ShortRangeUserFreq
      Uses short-range detection mode for improved detection under high ambient infrared light conditions. Uses user-specified update frequency.
    • LongRangeUserFreq

      public static final UpdateModeValue LongRangeUserFreq
      Uses long-range detection mode and user-specified update frequency.
  • Field Details

    • value

      public final int value
  • Method Details

    • values

      public static UpdateModeValue[] 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 UpdateModeValue 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 UpdateModeValue valueOf(int value)
      Gets UpdateModeValue from specified value
      Parameters:
      value - Value of UpdateModeValue
      Returns:
      UpdateModeValue of specified value