Class ConfigIdListMessage


public final class ConfigIdListMessage extends AntMessageFromHost
Configures the inclusion/exclusion list of channel IDs checked against while searching.
Since:
4.0
  • Field Details

    • 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:
    • SIZE_EXCLUDE

      public static final int SIZE_EXCLUDE
      The number of bytes used for exclude flag value
      Since:
      4.0
      See Also:
    • OFFSET_LIST_SIZE

      public static final int OFFSET_LIST_SIZE
      The message content offset to the list size value
      Since:
      4.0
      See Also:
    • OFFSET_EXCLUDE

      public static final int OFFSET_EXCLUDE
      The message content offset to the exclude flag value
      Since:
      4.0
      See Also:
    • MIN_LIST_SIZE

      public static final int MIN_LIST_SIZE
      The minimum list size accepted by ANT
      Since:
      4.0
      See Also:
    • MAX_LIST_SIZE

      public static final int MAX_LIST_SIZE
      The maximum list size accepted by ANT
      Since:
      4.0
      See Also:
  • Constructor Details

    • 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
    • ConfigIdListMessage

      protected ConfigIdListMessage(byte[] messageContent)
  • Method Details

    • 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 String toString()
      Overrides:
      toString in class AntMessageFromHost