Package com.dsi.ant.message.fromhost
Class LowPrioritySearchTimeoutMessage
java.lang.Object
com.dsi.ant.message.AntMessage
com.dsi.ant.message.fromhost.AntMessageFromHost
com.dsi.ant.message.fromhost.LowPrioritySearchTimeoutMessage
Configures the low priority search timeout for the channel when searching.
- Since:
- 4.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The message content offset to the search timeout valuestatic final int
The number of bytes to be used for the search timeout valueFields 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
LowPrioritySearchTimeoutMessage
(byte[] messageContent) LowPrioritySearchTimeoutMessage
(LowPrioritySearchTimeout searchTimeout) Constructs the message from the given low priority search timeout. -
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.int
Gets the raw value of low priority search timeout enumeration value.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
-
OFFSET_SEARCH_TIMEOUT
public static final int OFFSET_SEARCH_TIMEOUTThe message content offset to the search timeout value- Since:
- 4.0
- See Also:
-
SIZE_SEARCH_TIMEOUT
public static final int SIZE_SEARCH_TIMEOUTThe number of bytes to be used for the search timeout value- Since:
- 4.0
- See Also:
-
-
Constructor Details
-
LowPrioritySearchTimeoutMessage
Constructs the message from the given low priority search timeout.- Parameters:
searchTimeout
- TheLowPrioritySearchTimeout
.- Since:
- 4.0
-
LowPrioritySearchTimeoutMessage
protected LowPrioritySearchTimeoutMessage(byte[] messageContent)
-
-
Method Details
-
getRawSearchTimeout
public int getRawSearchTimeout()Gets the raw value of low priority search timeout enumeration value.- Returns:
- The raw value of the
LowPrioritySearchTimeout
. - 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
-