com.dsi.ant.message.fromhost

Class RequestMessage

java.lang.Object

com.dsi.ant.message.AntMessage

com.dsi.ant.message.fromhost.AntMessageFromHost

com.dsi.ant.message.fromhost.RequestMessage

public final class RequestMessage
extends AntMessageFromHost

Sent to the ANT chip to request specific information about the device.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	OFFSET_NVM_ADDRESS The message content offset to the start read address of NVM
static int	OFFSET_NVM_SIZE The message content offset to the block size to be read from NVM
static int	OFFSET_REQUESTED_MESSAGE_ID The message content offset to the requested message ID
static int	OFFSET_SUB_MESSAGE_ID The message content offset to the sub message ID
static int	SIZE_NVM_ADDRESS The number of bytes to be used for the start read address of NVM
static int	SIZE_NVM_SIZE The number of bytes to be used for the block size to be read from NVM
static int	SIZE_REQUESTED_MESSAGE_ID The number of bytes to be used for the requested message ID
static int	SIZE_SUB_MESSAGE_ID The number of bytes to be used for the sub message ID
static int	SUB_MESSAGE_REQUEST_ADVANCED_BURST_CAPABILITES The sub message ID if requesting advanced burst capabilities message
static int	SUB_MESSAGE_REQUEST_ADVANCED_BURST_CURRENT_CONFIGURATION The sub message ID if requesting advanced burst configuration

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
RequestMessage(MessageFromAntType requestedMessageType) Constructs the message from the given message type.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getMessageContent(int channelNumber, int networkNumber) The content of the message with specified channel number and network number set if required.
MessageFromHostType	getMessageType() The unique type of this message based on its message id, contents, and intended channel type.
MessageFromAntType	getRequestedMessageType() Gets the message type being requested in this message.
java.lang.String	toString()

Methods inherited from class com.dsi.ant.message.fromhost.AntMessageFromHost

createAntMessage, getMessageContent, getMessageContent, getMessageId, getRawMessage

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_SUB_MESSAGE_ID

public static final int SIZE_SUB_MESSAGE_ID

The number of bytes to be used for the sub message ID

Since:

4.0

See Also:

Constant Field Values

SIZE_REQUESTED_MESSAGE_ID

public static final int SIZE_REQUESTED_MESSAGE_ID

The number of bytes to be used for the requested message ID

Since:

4.0

See Also:

Constant Field Values

SIZE_NVM_ADDRESS

public static final int SIZE_NVM_ADDRESS

The number of bytes to be used for the start read address of NVM

Since:

4.0

See Also:

Constant Field Values

SIZE_NVM_SIZE

public static final int SIZE_NVM_SIZE

The number of bytes to be used for the block size to be read from NVM

Since:

4.0

See Also:

Constant Field Values

OFFSET_SUB_MESSAGE_ID

public static final int OFFSET_SUB_MESSAGE_ID

The message content offset to the sub message ID

Since:

4.0

See Also:

Constant Field Values

OFFSET_REQUESTED_MESSAGE_ID

public static final int OFFSET_REQUESTED_MESSAGE_ID

The message content offset to the requested message ID

Since:

4.0

See Also:

Constant Field Values

OFFSET_NVM_ADDRESS

public static final int OFFSET_NVM_ADDRESS

The message content offset to the start read address of NVM

Since:

4.0

See Also:

Constant Field Values

OFFSET_NVM_SIZE

public static final int OFFSET_NVM_SIZE

The message content offset to the block size to be read from NVM

Since:

4.0

See Also:

Constant Field Values

SUB_MESSAGE_REQUEST_ADVANCED_BURST_CAPABILITES

public static final int SUB_MESSAGE_REQUEST_ADVANCED_BURST_CAPABILITES

The sub message ID if requesting advanced burst capabilities message

Since:

4.0

See Also:

Constant Field Values

SUB_MESSAGE_REQUEST_ADVANCED_BURST_CURRENT_CONFIGURATION

public static final int SUB_MESSAGE_REQUEST_ADVANCED_BURST_CURRENT_CONFIGURATION

The sub message ID if requesting advanced burst configuration

Since:

4.0

See Also:

Constant Field Values

Constructor Detail

RequestMessage

public RequestMessage(MessageFromAntType requestedMessageType)

Constructs the message from the given message type.

Parameters:

requestedMessageType - The message being requested.

Since:

4.0

Method Detail

getRequestedMessageType

public MessageFromAntType getRequestedMessageType()

Gets the message type being requested in this message.

Returns:

The message type being requested.

Since:

4.0

getMessageContent

public byte[] getMessageContent(int channelNumber,
                       int networkNumber)

Description copied from class: AntMessageFromHost

The content of the message with specified channel number and network number set if required.

Specified by:

getMessageContent in class AntMessageFromHost

Parameters:

channelNumber - Written to the channel number byte if required

networkNumber - Written to the network number byte if required

Returns:

Message content raw byte array.

Since:

4.0

getMessageType

public MessageFromHostType getMessageType()

Description copied from class: AntMessageFromHost

The unique type of this message based on its message id, contents, and intended channel type.

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

Specified by:

getMessageType in class AntMessageFromHost

Returns:

The type of message returned by the host.

Since:

4.0

toString

public java.lang.String toString()

Overrides:

toString in class AntMessageFromHost