Package com.dsi.ant.message.fromhost

Class ChannelSearchPriorityMessage

java.lang.Object
com.dsi.ant.message.AntMessage
com.dsi.ant.message.fromhost.AntMessageFromHost
com.dsi.ant.message.fromhost.ChannelSearchPriorityMessage
public final class ChannelSearchPriorityMessage extends AntMessageFromHost

  • Field Details

    • OFFSET_SEARCH_PRIORITY

      public static final int OFFSET_SEARCH_PRIORITY
      The message content offset to the channel period
      Since:
      4.7.3
      See Also:

    • SIZE_SEARCH_PRIORITY

      public static final int SIZE_SEARCH_PRIORITY
      The number of bytes used for the channel period
      Since:
      4.7.3
      See Also:

    • LIB_MAX_SEARCH_PRIORITY

      public static final int LIB_MAX_SEARCH_PRIORITY
      Min and max of allowable channel search priority when set with API. The ranges [0 - 3] and [12 - 15] are system reserved.
      See Also:

    • LIB_MIN_SEARCH_PRIORITY

      public static final int LIB_MIN_SEARCH_PRIORITY
      See Also:

    • LIB_DEFAULT_SEARCH_PRIORITY

      public static final int LIB_DEFAULT_SEARCH_PRIORITY
      default search priority of a channel
      See Also:

  • Constructor Details

    • ChannelSearchPriorityMessage

      public ChannelSearchPriorityMessage(int searchPriority)
      Constructs the message from the given channel search priority [4 - 11]. Higher numbers are given higher priority.
      Parameters:
      searchPriority - priority to be used for this channel.
      Since:
      4.7.3

    • ChannelSearchPriorityMessage

      protected ChannelSearchPriorityMessage(byte[] messageContent)

  • Method Details

    • getChannelSearchPriority

      public int getChannelSearchPriority()
      Gets the channel search priority this message configures.
      Returns:
      The channel search priority.
      Since:
      4.7.3

    • 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.7.3

    • 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.7.3

    • toString

      public String toString()
      Overrides:
      toString in class AntMessageFromHost