com.dsi.ant.message.fromant

Class ChannelEventMessage

java.lang.Object

com.dsi.ant.message.AntMessage

com.dsi.ant.message.fromant.AntMessageFromAnt

com.dsi.ant.message.fromant.ChannelEventMessage

public class ChannelEventMessage
extends AntMessageFromAnt

Defines values for reading an MessageFromAntType.CHANNEL_EVENT type message.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	OFFSET_EVENT_CODE The message content offset to the channel event code (EventCode).
static int	SIZE_EVENT_CODE The number of bytes used for the event code

Fields inherited from class com.dsi.ant.message.AntMessage

BITMASK_CHANNEL_NUMBER, FILLER_BYTE, OFFSET_CHANNEL_NUMBER, RAW_OFFSET_MESSAGE_CONTENT_START, RAW_OFFSET_MESSAGE_ID, RAW_OFFSET_MESSAGE_SIZE, SIZE_CHANNEL_NUMBER, SIZE_FILLER_BYTE

Constructor Summary

Constructors

Constructor and Description
ChannelEventMessage(AntMessageParcel messageParcel) Parse message specific information from the given ANT message parcel.

Method Summary

Methods

Modifier and Type	Method and Description
EventCode	getEventCode() Gets the event code associated with the channel event message
MessageFromAntType	getMessageType() The type of this message based on its message id and contents.
java.lang.String	toString()

Methods inherited from class com.dsi.ant.message.fromant.AntMessageFromAnt

createAntMessage, createAntMessage, getMessageContent, getMessageId

Methods inherited from class com.dsi.ant.message.AntMessage

equals, getMessageContentString, getMessageIdString, hashCode, maskChannelNumber

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

SIZE_EVENT_CODE

public static final int SIZE_EVENT_CODE

The number of bytes used for the event code

Since:

4.0

See Also:

Constant Field Values

OFFSET_EVENT_CODE

public static final int OFFSET_EVENT_CODE

The message content offset to the channel event code (EventCode).

Since:

4.0

See Also:

Constant Field Values

Constructor Detail

ChannelEventMessage

public ChannelEventMessage(AntMessageParcel messageParcel)

Parse message specific information from the given ANT message parcel.

Parameters:

messageParcel - Raw ANT message received form the ANT Radio Service.

Throws:

java.lang.IllegalArgumentException - If the parcel is for the wrong message type.

Since:

4.0

Method Detail

getEventCode

public EventCode getEventCode()

Gets the event code associated with the channel event message

Returns:

The EventCode.

Since:

4.0

getMessageType

public MessageFromAntType getMessageType()

Description copied from class: AntMessageFromAnt

The type of this message based on its message id and contents.

It is recommended to use this rather than the raw message ID.

Specified by:

getMessageType in class AntMessageFromAnt

Returns:

A message type corresponding to this message as defined in MessageFromAntType.

Since:

4.0

toString

public java.lang.String toString()

Overrides:

toString in class AntMessageFromAnt

Since:

4.0