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

public final class AddChannelIdToListMessage
extends AntMessageFromHost

Message to add a channel ID to an exclusion/inclusion list.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_LIST_INDEX The maximum index allowed for the list
static int	MIN_LIST_INDEX The minimum index allowed for the list
static int	OFFSET_CHANNEL_ID The message content offset to the channel ID
static int	OFFSET_LIST_INDEX The message content offset to the type of list being added to
static int	SIZE_LIST_INDEX The number of bytes used for the list index

Fields 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

Constructors

Constructor and Description
AddChannelIdToListMessage(ChannelId channelId, int listIndex) Constructs the message given the channel ID and list index.

Method Summary

Methods

Modifier and Type	Method and Description
ChannelId	getChannelId() Gets the channel ID being added to a list.
int	getListIndex() 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.
MessageFromHostType	getMessageType() The unique type of this message based on its message id, contents, and intended channel type.
java.lang.String	toString()

Methods inherited from class com.dsi.ant.message.fromhost.AntMessageFromHost

createAntMessage, getMessageContent, getMessageContent, getMessageId, getRawMessage

Methods inherited from class com.dsi.ant.message.AntMessage

equals, getMessageContentString, getMessageIdString, hashCode, maskChannelNumber

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

OFFSET_CHANNEL_ID

public static final int OFFSET_CHANNEL_ID

The message content offset to the channel ID

Since:

4.0

See Also:

Constant Field Values

OFFSET_LIST_INDEX

public static final int OFFSET_LIST_INDEX

The message content offset to the type of list being added to

Since:

4.0

See Also:

Constant Field Values

SIZE_LIST_INDEX

public static final int SIZE_LIST_INDEX

The number of bytes used for the list index

Since:

4.0

See Also:

Constant Field Values

MIN_LIST_INDEX

public static final int MIN_LIST_INDEX

The minimum index allowed for the list

Since:

4.0

See Also:

Constant Field Values

MAX_LIST_INDEX

public static final int MAX_LIST_INDEX

The maximum index allowed for the list

Since:

4.0

See Also:

Constant Field Values

Constructor Detail

AddChannelIdToListMessage

public AddChannelIdToListMessage(ChannelId channelId,
                         int listIndex)

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

Method Detail

getChannelId

public ChannelId 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 class AntMessageFromHost

Parameters:

channelNumber - Written to the channel number byte if required

networkNumber - Written to the network number byte if required

Returns:

Message content raw byte array.

Since:

4.0

getMessageType

public MessageFromHostType 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 class AntMessageFromHost

Returns:

The type of message returned by the host.

Since:

4.0

toString

public java.lang.String toString()

Overrides:

toString in class AntMessageFromHost