Package com.dsi.ant.message.fromhost

Class ChannelIdMessageFromHost

java.lang.Object
com.dsi.ant.message.AntMessage
com.dsi.ant.message.fromhost.AntMessageFromHost
com.dsi.ant.message.fromhost.ChannelIdMessageFromHost
public final class ChannelIdMessageFromHost extends AntMessageFromHost
Configures the channel's channel ID.
Since:
4.0

  • Field Details

    • OFFSET_CHANNEL_ID

      public static final int OFFSET_CHANNEL_ID
      The message content offset to the channel ID
      Since:
      4.0
      See Also:

  • Constructor Details

    • ChannelIdMessageFromHost

      public ChannelIdMessageFromHost(ChannelId channelId)
      Constructs the message from the given channel ID.
      Parameters:
      channelId - The channel ID to be set for the channel.
      Since:
      4.0

    • ChannelIdMessageFromHost

      protected ChannelIdMessageFromHost(byte[] messageContent)

  • Method Details

    • getChannelId

      public ChannelId getChannelId()
      Gets the channel ID for the channel.
      Returns:
      The ChannelId.
      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
      Since:
      4.0