com.dsi.ant.message

Enum EventCode

java.lang.Object

java.lang.Enum<EventCode>

com.dsi.ant.message.EventCode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EventCode>

public enum EventCode
extends java.lang.Enum<EventCode>

The possible event codes that a ChannelEventMessage can contain.

Since:

4.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHANNEL_CLOSED The channel has been successfully closed.
CHANNEL_COLLISION Two channels have drifted into each other and overlapped in time on the device causing one channel to be blocked.
RX_FAIL A receive channel missed a message which it was expecting.
RX_FAIL_GO_TO_SEARCH The channel has dropped to search mode after missing too many messages.
RX_SEARCH_TIMEOUT A receive channel has timed out on searching.
TRANSFER_RX_FAILED A receive transfer has failed
TRANSFER_TX_COMPLETED An Acknowledged Data message or a Burst Transfer sequence has been completed successfully.
TRANSFER_TX_FAILED An Acknowledged Data message, or a Burst Transfer Message has been initiated and the transmission failed to complete successfully
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.
TX A broadcast message has been transmitted successfully.
UNKNOWN The value sent from the ANT Radio Service is not defined in this version of the API

Method Summary

Methods

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

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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

RX_FAIL_GO_TO_SEARCH

public static final EventCode RX_FAIL_GO_TO_SEARCH

The channel has dropped to search mode after missing too many messages.

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 Detail

values

public static EventCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EventCode c : EventCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EventCode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.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