Package com.dsi.ant.message.fromhost
Class LibConfigMessage
java.lang.Object
com.dsi.ant.message.AntMessage
com.dsi.ant.message.fromhost.AntMessageFromHost
com.dsi.ant.message.fromhost.LibConfigMessage
Configures which extended data information to be included in the received
messages from devices.
- Since:
- 4.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The mask to be used to get the enable channel ID flagstatic final int
The mask to be used to get the enable RSSI data flagstatic final int
The mask to be used to get the enable timestamp flagstatic final int
The message content offset to the byte containing the values for the flagsstatic final int
The number of bytes used for the flagsFields 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
LibConfigMessage
(byte[] messageContent) LibConfigMessage
(LibConfig libConfig) Constructs the message from the given LibConfig object -
Method Summary
Modifier and TypeMethodDescriptionGets the LibConfig object that is represented by this message.byte[]
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.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
-
BITMASK_RX_TIMESTAMP
public static final int BITMASK_RX_TIMESTAMPThe mask to be used to get the enable timestamp flag- Since:
- 4.0
- See Also:
-
BITMASK_RSSI_OUTPUT
public static final int BITMASK_RSSI_OUTPUTThe mask to be used to get the enable RSSI data flag- Since:
- 4.0
- See Also:
-
BITMASK_CHANNEL_ID_OUTPUT
public static final int BITMASK_CHANNEL_ID_OUTPUTThe mask to be used to get the enable channel ID flag- Since:
- 4.0
- See Also:
-
OFFSET_LIBCONFIG_FLAGS
public static final int OFFSET_LIBCONFIG_FLAGSThe message content offset to the byte containing the values for the flags- Since:
- 4.0
- See Also:
-
SIZE_LIBCONFIG_FLAGS
public static final int SIZE_LIBCONFIG_FLAGSThe number of bytes used for the flags- Since:
- 4.0
- See Also:
-
-
Constructor Details
-
LibConfigMessage
Constructs the message from the given LibConfig object- Parameters:
libConfig
- The desiredLibConfig
.- Since:
- 4.0
-
LibConfigMessage
protected LibConfigMessage(byte[] messageContent)
-
-
Method Details
-
getLibConfig
Gets the LibConfig object that is represented by this message.- Returns:
- The desired
LibConfig
. - 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
-