com.dsi.ant.message.fromant

Class AntMessageFromAnt

java.lang.Object

com.dsi.ant.message.AntMessage

com.dsi.ant.message.fromant.AntMessageFromAnt

Direct Known Subclasses:

AntVersionMessage, CapabilitiesMessage, ChannelEventMessage, ChannelIdMessage, ChannelResponseMessage, ChannelStatusMessage, DataMessage, SerialNumberMessage

public abstract class AntMessageFromAnt
extends AntMessage

A message sent ANT -> Host. Takes a raw ANT message (single byte array) and sends it from the ANT Radio Service to an application, where it is constructed as the specific object that represents the message, and parses the information out.

Since:

4.0

Field Summary

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

Method Summary

Methods

Modifier and Type	Method and Description
static AntMessageFromAnt	createAntMessage(AntMessageParcel antParcel) Takes a message received over IPC and converts it to an AntMessageFromAnt object
static AntMessageFromAnt	createAntMessage(byte[] rawMessage) Takes a message read from the chip and converts it to an AntMessageFromAnt object
byte[]	getMessageContent() The content of the message.
int	getMessageId() Get the ANT message ID.
abstract 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.AntMessage

equals, getMessageContentString, getMessageIdString, hashCode, maskChannelNumber

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getMessageId

public int getMessageId()

Description copied from class: AntMessage

Get the ANT message ID.

Specified by:

getMessageId in class AntMessage

Returns:

Raw value of this messages Message ID byte.

Since:

4.0

getMessageContent

public byte[] getMessageContent()

Description copied from class: AntMessage

The content of the message.

Specified by:

getMessageContent in class AntMessage

Returns:

Message content raw byte array.

Since:

4.0

getMessageType

public abstract MessageFromAntType getMessageType()

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

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

Returns:

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

Since:

4.0

createAntMessage

public static AntMessageFromAnt createAntMessage(byte[] rawMessage)

Takes a message read from the chip and converts it to an AntMessageFromAnt object

Parameters:

rawMessage - The basic ANT message data received from the chip.

Returns:

A new specific com.dsi.ant.message.fromant message instance, or NULL if not a From ANT message or not a known MessageFromAntType.

Since:

4.0

createAntMessage

public static AntMessageFromAnt createAntMessage(AntMessageParcel antParcel)

Takes a message received over IPC and converts it to an AntMessageFromAnt object

Parameters:

antParcel - The basic ANT message data received over IPC.

Returns:

A new specific com.dsi.ant.message.fromant message instance, or NULL if not a From ANT message or not a known MessageFromAntType.

Since:

4.0

toString

public java.lang.String toString()

Overrides:

toString in class AntMessage

Since:

4.0