Package com.dsi.ant.message.fromhost
Class ChannelIdMessageFromHost
java.lang.Object
com.dsi.ant.message.AntMessage
com.dsi.ant.message.fromhost.AntMessageFromHost
com.dsi.ant.message.fromhost.ChannelIdMessageFromHost
Configures the channel's channel ID.
- Since:
- 4.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The message content offset to the channel IDFields 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
ChannelIdMessageFromHost
(byte[] messageContent) ChannelIdMessageFromHost
(ChannelId channelId) Constructs the message from the given channel ID. -
Method Summary
Modifier and TypeMethodDescriptionGets the channel ID for the channel.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
-
OFFSET_CHANNEL_ID
public static final int OFFSET_CHANNEL_IDThe message content offset to the channel ID- Since:
- 4.0
- See Also:
-
-
Constructor Details
-
ChannelIdMessageFromHost
Constructs the message from the given channel ID.- Parameters:
channelId
- The channel ID to be set for the channel.- Since:
- 4.0
-
ChannelIdMessageFromHost
protected ChannelIdMessageFromHost(byte[] messageContent)
-
-
Method Details
-
getChannelId
Gets the channel ID for the channel.- Returns:
- The
ChannelId
. - 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
- Since:
- 4.0
-