com.dsi.ant.message.fromant

Class BurstTransferDataMessage

java.lang.Object

com.dsi.ant.message.AntMessage

com.dsi.ant.message.fromant.AntMessageFromAnt

com.dsi.ant.message.fromant.DataMessage

com.dsi.ant.message.fromant.BurstTransferDataMessage

public class BurstTransferDataMessage
extends DataMessage

Message received when receiving burst data from a connected device and every burst packet is acknowledged.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	BITMASK_SEQUENCE_NUMBER The mask used to retrieve the sequence number
static int	OFFSET_SEQUENCE_NUMBER The message content offset to the sequence number
static int	SEQUENCE_FIRST_MESSAGE The sequence number for the first message of the burst transfer
static int	SEQUENCE_FLAG_IS_LAST_MESSAGE The mask used to get the flag indicating if this message is the last message in the burst transfer.
static int	SEQUENCE_NUMBER_INC The value the sequence number increments with each received message
static int	SEQUENCE_NUMBER_ROLLOVER The sequence number before a rollover of sequence numbers occurs
static int	SHIFT_SEQUENCE_NUMBER The shift applied to the retrieved sequence number after applying the mask

Fields inherited from class com.dsi.ant.message.fromant.DataMessage

LENGTH_STANDARD_PAYLOAD, OFFSET_PAYLOAD_START

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
BurstTransferDataMessage(AntMessageParcel messageParcel) Parse message specific information from the given ANT message parcel.

Method Summary

Methods

Modifier and Type	Method and Description
MessageFromAntType	getMessageType() The type of this message based on its message id and contents.
int	getSequenceNumber() Gets the sequence number of this received message in the burst transfer
boolean	isFirstMessage() Checks if the message is the first message of the burst transfer.
boolean	isLastMessage() Checks if the message is the last message of the burst transfer.
java.lang.String	toString()

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

getExtendedData, getPayload, hasExtendedData

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

OFFSET_SEQUENCE_NUMBER

public static final int OFFSET_SEQUENCE_NUMBER

The message content offset to the sequence number

Since:

4.0

See Also:

Constant Field Values

BITMASK_SEQUENCE_NUMBER

public static final int BITMASK_SEQUENCE_NUMBER

The mask used to retrieve the sequence number

Since:

4.0

See Also:

Constant Field Values

SHIFT_SEQUENCE_NUMBER

public static final int SHIFT_SEQUENCE_NUMBER

The shift applied to the retrieved sequence number after applying the mask

Since:

4.0

See Also:

Constant Field Values

SEQUENCE_FIRST_MESSAGE

public static final int SEQUENCE_FIRST_MESSAGE

The sequence number for the first message of the burst transfer

Since:

4.0

See Also:

Constant Field Values

SEQUENCE_NUMBER_INC

public static final int SEQUENCE_NUMBER_INC

The value the sequence number increments with each received message

Since:

4.0

See Also:

Constant Field Values

SEQUENCE_NUMBER_ROLLOVER

public static final int SEQUENCE_NUMBER_ROLLOVER

The sequence number before a rollover of sequence numbers occurs

Since:

4.0

See Also:

Constant Field Values

SEQUENCE_FLAG_IS_LAST_MESSAGE

public static final int SEQUENCE_FLAG_IS_LAST_MESSAGE

The mask used to get the flag indicating if this message is the last message in the burst transfer.

Since:

4.1

See Also:

Constant Field Values

Constructor Detail

BurstTransferDataMessage

public BurstTransferDataMessage(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

getSequenceNumber

public int getSequenceNumber()

Gets the sequence number of this received message in the burst transfer

Returns:

The sequence number of the message.

Since:

4.0

isFirstMessage

public boolean isFirstMessage()

Checks if the message is the first message of the burst transfer.

Returns:

True, if message is the first message. False, otherwise.

Since:

4.0

isLastMessage

public boolean isLastMessage()

Checks if the message is the last message of the burst transfer.

Returns:

True, if message is the last message. False, otherwise.

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 DataMessage

Since:

4.0