Class LibConfigMessage


public final class LibConfigMessage extends AntMessageFromHost
Configures which extended data information to be included in the received messages from devices.
Since:
4.0
  • Field Details

    • BITMASK_RX_TIMESTAMP

      public static final int BITMASK_RX_TIMESTAMP
      The mask to be used to get the enable timestamp flag
      Since:
      4.0
      See Also:
    • BITMASK_RSSI_OUTPUT

      public static final int BITMASK_RSSI_OUTPUT
      The mask to be used to get the enable RSSI data flag
      Since:
      4.0
      See Also:
    • BITMASK_CHANNEL_ID_OUTPUT

      public static final int BITMASK_CHANNEL_ID_OUTPUT
      The mask to be used to get the enable channel ID flag
      Since:
      4.0
      See Also:
    • OFFSET_LIBCONFIG_FLAGS

      public static final int OFFSET_LIBCONFIG_FLAGS
      The message content offset to the byte containing the values for the flags
      Since:
      4.0
      See Also:
    • SIZE_LIBCONFIG_FLAGS

      public static final int SIZE_LIBCONFIG_FLAGS
      The number of bytes used for the flags
      Since:
      4.0
      See Also:
  • Constructor Details

    • LibConfigMessage

      public LibConfigMessage(LibConfig libConfig)
      Constructs the message from the given LibConfig object
      Parameters:
      libConfig - The desired LibConfig.
      Since:
      4.0
    • LibConfigMessage

      protected LibConfigMessage(byte[] messageContent)
  • Method Details

    • getLibConfig

      public LibConfig getLibConfig()
      Gets the LibConfig object that is represented by this message.
      Returns:
      The desired LibConfig.
      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