Package com.dsi.ant.message.fromhost
Class AddChannelIdToListMessage
java.lang.Object
com.dsi.ant.message.AntMessage
com.dsi.ant.message.fromhost.AntMessageFromHost
com.dsi.ant.message.fromhost.AddChannelIdToListMessage
Message to add a channel ID to an exclusion/inclusion list.
- Since:
- 4.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The maximum index allowed for the liststatic final int
The minimum index allowed for the liststatic final int
The message content offset to the channel IDstatic final int
The message content offset to the type of list being added tostatic final int
The number of bytes used for the list indexFields 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
AddChannelIdToListMessage
(byte[] messageContent) Constructs the message from the given message bytes.AddChannelIdToListMessage
(ChannelId channelId, int listIndex) Constructs the message given the channel ID and list index. -
Method Summary
Modifier and TypeMethodDescriptionGets the channel ID being added to a list.int
Gets the index the channel ID is being placed in.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:
-
OFFSET_LIST_INDEX
public static final int OFFSET_LIST_INDEXThe message content offset to the type of list being added to- Since:
- 4.0
- See Also:
-
SIZE_LIST_INDEX
public static final int SIZE_LIST_INDEXThe number of bytes used for the list index- Since:
- 4.0
- See Also:
-
MIN_LIST_INDEX
public static final int MIN_LIST_INDEXThe minimum index allowed for the list- Since:
- 4.0
- See Also:
-
MAX_LIST_INDEX
public static final int MAX_LIST_INDEXThe maximum index allowed for the list- Since:
- 4.0
- See Also:
-
-
Constructor Details
-
AddChannelIdToListMessage
Constructs the message given the channel ID and list index.- Parameters:
channelId
- The channel ID to be inserted to the list.listIndex
- The position the channel ID will be placed.- Since:
- 4.0
-
AddChannelIdToListMessage
protected AddChannelIdToListMessage(byte[] messageContent) Constructs the message from the given message bytes.- Parameters:
messageContent
- The bytes of the message.
-
-
Method Details
-
getChannelId
Gets the channel ID being added to a list.- Returns:
- The
ChannelId
. - Since:
- 4.0
-
getListIndex
public int getListIndex()Gets the index the channel ID is being placed in.- Returns:
- The index.
- 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
-