com.dsi.ant.message.fromant

Class ChannelResponseMessage

java.lang.Object

com.dsi.ant.message.AntMessage

com.dsi.ant.message.fromant.AntMessageFromAnt

com.dsi.ant.message.fromant.ChannelResponseMessage

public class ChannelResponseMessage
extends AntMessageFromAnt

Message generated in response to a message.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	OFFSET_INITIATING_MESSAGE_ID The message content offset to the previously sent message ID that the response is for.
static int	OFFSET_RESPONSE_CODE The message content offset to the response code (ResponseCode).
static int	SIZE_INITIATING_MESSAGE_ID The number of bytes used for the initiating message ID
static int	SIZE_RESPONSE_CODE The number of bytes used for the response 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
ChannelResponseMessage(AntMessageParcel messageParcel) Parse message specific information from the given ANT message parcel.

Method Summary

Methods

Modifier and Type	Method and Description
int	getInitiatingMessageId() Gets the message ID of the message that was sent to ANT.
MessageFromAntType	getMessageType() The type of this message based on its message id and contents.
int	getRawResponseCode() Should generally use getResponseCode() instead.
ResponseCode	getResponseCode() Gets the response code associated with the response message.
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_INITIATING_MESSAGE_ID

public static final int SIZE_INITIATING_MESSAGE_ID

The number of bytes used for the initiating message ID

Since:

4.0

See Also:

Constant Field Values

SIZE_RESPONSE_CODE

public static final int SIZE_RESPONSE_CODE

The number of bytes used for the response code

Since:

4.0

See Also:

Constant Field Values

OFFSET_INITIATING_MESSAGE_ID

public static final int OFFSET_INITIATING_MESSAGE_ID

The message content offset to the previously sent message ID that the response is for.

Since:

4.0

See Also:

Constant Field Values

OFFSET_RESPONSE_CODE

public static final int OFFSET_RESPONSE_CODE

The message content offset to the response code (ResponseCode).

Since:

4.0

See Also:

Constant Field Values

Constructor Detail

ChannelResponseMessage

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

getInitiatingMessageId

public int getInitiatingMessageId()

Gets the message ID of the message that was sent to ANT.

Returns:

The value corresponding to an element in MessageId.

Since:

4.0

getRawResponseCode

public int getRawResponseCode()

Should generally use getResponseCode() instead.

Returns:

The raw value received from the ANT Adapter.

Since:

4.0

getResponseCode

public ResponseCode getResponseCode()

Gets the response code associated with the response message.

Returns:

The ResponseCode.

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