Package 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
Sent to the ANT chip to request specific information about the device.
- Since:
- 4.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The message content offset to the start read address of NVMstatic final int
The message content offset to the block size to be read from NVMstatic final int
The message content offset to the requested message IDstatic final int
The message content offset to the sub message IDstatic final int
The number of bytes to be used for the start read address of NVMstatic final int
The number of bytes to be used for the block size to be read from NVMstatic final int
The number of bytes to be used for the requested message IDstatic final int
The number of bytes to be used for the sub message IDstatic final int
The sub message ID if requesting advanced burst capabilities messagestatic final int
The sub message ID if requesting advanced burst configurationFields 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
ConstructorsModifierConstructorDescriptionprotected
RequestMessage
(byte[] messageContent) RequestMessage
(MessageFromAntType requestedMessageType) Constructs the message from the given message type. -
Method Summary
Modifier and TypeMethodDescriptionbyte[]
getMessageContent
(int channelNumber, int networkNumber) The content of the message with specified channel number and network number set if required.The unique type of this message based on its message id, contents, and intended channel type.Gets the message type being requested in this message.toString()
Methods inherited from class com.dsi.ant.message.fromhost.AntMessageFromHost
createAntMessage, createAntMessage, getMessageContent, getMessageContent, getMessageId, getRawMessage, toStringHeader
Methods inherited from class com.dsi.ant.message.AntMessage
equals, getMessageContentString, getMessageIdString, hashCode, maskChannelNumber
-
Field Details
-
SIZE_SUB_MESSAGE_ID
public static final int SIZE_SUB_MESSAGE_IDThe number of bytes to be used for the sub message ID- Since:
- 4.0
- See Also:
-
SIZE_REQUESTED_MESSAGE_ID
public static final int SIZE_REQUESTED_MESSAGE_IDThe number of bytes to be used for the requested message ID- Since:
- 4.0
- See Also:
-
SIZE_NVM_ADDRESS
public static final int SIZE_NVM_ADDRESSThe number of bytes to be used for the start read address of NVM- Since:
- 4.0
- See Also:
-
SIZE_NVM_SIZE
public static final int SIZE_NVM_SIZEThe number of bytes to be used for the block size to be read from NVM- Since:
- 4.0
- See Also:
-
OFFSET_SUB_MESSAGE_ID
public static final int OFFSET_SUB_MESSAGE_IDThe message content offset to the sub message ID- Since:
- 4.0
- See Also:
-
OFFSET_REQUESTED_MESSAGE_ID
public static final int OFFSET_REQUESTED_MESSAGE_IDThe message content offset to the requested message ID- Since:
- 4.0
- See Also:
-
OFFSET_NVM_ADDRESS
public static final int OFFSET_NVM_ADDRESSThe message content offset to the start read address of NVM- Since:
- 4.0
- See Also:
-
OFFSET_NVM_SIZE
public static final int OFFSET_NVM_SIZEThe message content offset to the block size to be read from NVM- Since:
- 4.0
- See Also:
-
SUB_MESSAGE_REQUEST_ADVANCED_BURST_CAPABILITES
public static final int SUB_MESSAGE_REQUEST_ADVANCED_BURST_CAPABILITESThe sub message ID if requesting advanced burst capabilities message- Since:
- 4.0
- See Also:
-
SUB_MESSAGE_REQUEST_ADVANCED_BURST_CURRENT_CONFIGURATION
public static final int SUB_MESSAGE_REQUEST_ADVANCED_BURST_CURRENT_CONFIGURATIONThe sub message ID if requesting advanced burst configuration- Since:
- 4.0
- See Also:
-
-
Constructor Details
-
RequestMessage
Constructs the message from the given message type.- Parameters:
requestedMessageType
- The message being requested.- Since:
- 4.0
-
RequestMessage
protected RequestMessage(byte[] messageContent)
-
-
Method Details
-
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 classAntMessageFromHost
- Parameters:
channelNumber
- Written to the channel number byte if requirednetworkNumber
- Written to the network number byte if required- Returns:
- Message content raw byte array.
- Since:
- 4.0
-
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 classAntMessageFromHost
- Returns:
- The type of message returned by the host.
- Since:
- 4.0
-
toString
- Overrides:
toString
in classAntMessageFromHost
-