Enum Class EventCode

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

public enum EventCode extends Enum<EventCode>
The possible event codes that a ChannelEventMessage can contain.
Since:
4.0
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    The channel has been successfully closed.
    Two channels have drifted into each other and overlapped in time on the device causing one channel to be blocked.
    A receive channel missed a message which it was expecting.
    The channel has dropped to search mode after missing too many messages.
    A receive channel has timed out on searching.
    A receive transfer has failed
    An Acknowledged Data message or a Burst Transfer sequence has been completed successfully.
    An Acknowledged Data message, or a Burst Transfer Message has been initiated and the transmission failed to complete successfully
    Sent after a burst transfer begins, effectively on the next channel period after the burst transfer message has been sent to the device.
    A broadcast message has been transmitted successfully.
    The value sent from the ANT Radio Service is not defined in this version of the API
  • Method Summary

    Modifier and Type
    Method
    Description
    static EventCode
    create(int rawValue)
    Creates the EventCode from the raw value.
    int
    Returns the raw value of this EventCode.
    static EventCode
    Returns the enum constant of this class with the specified name.
    static EventCode[]
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • RX_SEARCH_TIMEOUT

      public static final EventCode RX_SEARCH_TIMEOUT
      A receive channel has timed out on searching.
      Since:
      4.0
    • RX_FAIL

      public static final EventCode RX_FAIL
      A receive channel missed a message which it was expecting.
      Since:
      4.0
    • TX

      public static final EventCode TX
      A broadcast message has been transmitted successfully.
      Since:
      4.0
    • TRANSFER_RX_FAILED

      public static final EventCode TRANSFER_RX_FAILED
      A receive transfer has failed
    • TRANSFER_TX_COMPLETED

      public static final EventCode TRANSFER_TX_COMPLETED
      An Acknowledged Data message or a Burst Transfer sequence has been completed successfully.
      Since:
      4.0
    • TRANSFER_TX_FAILED

      public static final EventCode TRANSFER_TX_FAILED
      An Acknowledged Data message, or a Burst Transfer Message has been initiated and the transmission failed to complete successfully
      Since:
      4.0
    • CHANNEL_CLOSED

      public static final EventCode CHANNEL_CLOSED
      The channel has been successfully closed.
      Since:
      4.0
    • CHANNEL_COLLISION

      public static final EventCode CHANNEL_COLLISION
      Two channels have drifted into each other and overlapped in time on the device causing one channel to be blocked.
      Since:
      4.0
    • TRANSFER_TX_START

      public static final EventCode TRANSFER_TX_START
      Sent after a burst transfer begins, effectively on the next channel period after the burst transfer message has been sent to the device.
      Since:
      4.0
    • UNKNOWN

      public static final EventCode UNKNOWN
      The value sent from the ANT Radio Service is not defined in this version of the API
      Since:
      4.0
  • Method Details

    • values

      public static EventCode[] 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 EventCode 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 of this EventCode. Applications should use the enumeration values directly.
      Returns:
      The raw value.
      Since:
      4.0
    • create

      public static EventCode create(int rawValue)
      Creates the EventCode from the raw value. Applications should access the enumeration values directly.
      Parameters:
      rawValue - The raw value.
      Returns:
      The event code.
      Since:
      4.0