com.dsi.ant.message.fromant

Class DataMessage

java.lang.Object

com.dsi.ant.message.AntMessage

com.dsi.ant.message.fromant.AntMessageFromAnt

com.dsi.ant.message.fromant.DataMessage

Direct Known Subclasses:

AcknowledgedDataMessage, BroadcastDataMessage, BurstTransferDataMessage

public abstract class DataMessage
extends AntMessageFromAnt

Defines values for reading a MessageFromAntType.BROADCAST_DATA, MessageFromAntType.ACKNOWLEDGED_DATA, or MessageFromAntType.BURST_TRANSFER_DATA type message.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	LENGTH_STANDARD_PAYLOAD The length in bytes of the standard payload in a broadcast, acknowledged, or burst message.
static int	OFFSET_PAYLOAD_START The message content offset to the first byte of the payload.

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
ExtendedData	getExtendedData() Gets the extended data contained in the data message if it has extended data.
byte[]	getPayload() Extracts the data payload of the data message received.
boolean	hasExtendedData() Checks if the received data message contains extended data.
java.lang.String	toString()

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

createAntMessage, createAntMessage, getMessageContent, getMessageId, getMessageType

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

LENGTH_STANDARD_PAYLOAD

public static final int LENGTH_STANDARD_PAYLOAD

The length in bytes of the standard payload in a broadcast, acknowledged, or burst message.

Since:

4.0

See Also:

Constant Field Values

OFFSET_PAYLOAD_START

public static final int OFFSET_PAYLOAD_START

The message content offset to the first byte of the payload.

Since:

4.0

See Also:

Constant Field Values

Method Detail

getPayload

public byte[] getPayload()

Extracts the data payload of the data message received.

Returns:

The data payload.

Since:

4.0

hasExtendedData

public boolean hasExtendedData()

Checks if the received data message contains extended data.

Returns:

True, if there is extended data. False, otherwise.

Since:

4.0

getExtendedData

public ExtendedData getExtendedData()

Gets the extended data contained in the data message if it has extended data.

Returns:

The ExtendedData.

Since:

4.0

toString

public java.lang.String toString()

Overrides:

toString in class AntMessageFromAnt

Since:

4.0