Enum Class ChannelState

java.lang.Object
java.lang.Enum<ChannelState>
com.dsi.ant.message.ChannelState
All Implemented Interfaces:
Serializable, Comparable<ChannelState>, Constable

public enum ChannelState extends Enum<ChannelState>
The possible states an ANT channel can be in.
Since:
4.0
  • Enum Constant Details

    • UNASSIGNED

      public static final ChannelState UNASSIGNED
      Not configured and closed.
      Since:
      4.0
    • ASSIGNED

      public static final ChannelState ASSIGNED
      Ready to be configured and then opened.
      Since:
      4.0
    • SEARCHING

      public static final ChannelState SEARCHING
      Open and searching for devices with matching channel ID
      Since:
      4.0
    • TRACKING

      public static final ChannelState TRACKING
      Found and connected to a device.
      Since:
      4.0
    • INVALID

      public static final ChannelState INVALID
      Received state does not match possible states.
      Since:
      4.0
  • Method Details

    • values

      public static ChannelState[] 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 ChannelState 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
    • getRawValue

      public int getRawValue()
      Returns the raw value for this channel state. Applications should use the enumeration values directly.
      Returns:
      The raw value.
      Since:
      4.0
    • create

      public static ChannelState create(int rawValue)
      Creates the channel state from a raw value. Applications should use the enumeration values directly.
      Parameters:
      rawValue - The raw value.
      Returns:
      The channel state.
      Since:
      4.0