com.dsi.ant.message.fromhost

Class ConfigIdListMessage

java.lang.Object

com.dsi.ant.message.AntMessage

com.dsi.ant.message.fromhost.AntMessageFromHost

com.dsi.ant.message.fromhost.ConfigIdListMessage

public final class ConfigIdListMessage
extends AntMessageFromHost

Configures the inclusion/exclusion list of channel IDs checked against while searching.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_LIST_SIZE The maximum list size accepted by ANT
static int	MIN_LIST_SIZE The minimum list size accepted by ANT
static int	OFFSET_EXCLUDE The message content offset to the exclude flag value
static int	OFFSET_LIST_SIZE The message content offset to the list size value
static int	SIZE_EXCLUDE The number of bytes used for exclude flag value
static int	SIZE_LIST_SIZE The number of bytes used for the list size value

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
ConfigIdListMessage(int listSize, boolean exclude) Constructs the message from the given list size and exlude flag.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getExclude() Checks if the list is an exclusion or inclusion list.
int	getListSize() Gets the size of the list.
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

SIZE_LIST_SIZE

public static final int SIZE_LIST_SIZE

The number of bytes used for the list size value

Since:

4.0

See Also:

Constant Field Values

SIZE_EXCLUDE

public static final int SIZE_EXCLUDE

The number of bytes used for exclude flag value

Since:

4.0

See Also:

Constant Field Values

OFFSET_LIST_SIZE

public static final int OFFSET_LIST_SIZE

The message content offset to the list size value

Since:

4.0

See Also:

Constant Field Values

OFFSET_EXCLUDE

public static final int OFFSET_EXCLUDE

The message content offset to the exclude flag value

Since:

4.0

See Also:

Constant Field Values

MIN_LIST_SIZE

public static final int MIN_LIST_SIZE

The minimum list size accepted by ANT

Since:

4.0

See Also:

Constant Field Values

MAX_LIST_SIZE

public static final int MAX_LIST_SIZE

The maximum list size accepted by ANT

Since:

4.0

See Also:

Constant Field Values

Constructor Detail

ConfigIdListMessage

public ConfigIdListMessage(int listSize,
                   boolean exclude)

Constructs the message from the given list size and exlude flag.

Parameters:

listSize - The size of the list.

exclude - True, if the list is an exclusion list. False, if the list is an inclusion list.

Since:

4.0

Method Detail

getListSize

public int getListSize()

Gets the size of the list.

Returns:

The size of the list.

Since:

4.0

getExclude

public boolean getExclude()

Checks if the list is an exclusion or inclusion list.

Returns:

True, if the list is being configured as an exclusion list. False, if the list is being configured as an inclusion list.

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