Class ExtendedAssignment

java.lang.Object
com.dsi.ant.message.ExtendedAssignment

public final class ExtendedAssignment extends Object
Used when assigning a channel to enable additional ANT features such as frequency agility and background scanning.
Since:
4.0
  • Field Details

    • SIZE_EXTENDED_ASSIGNMENT

      public static final int SIZE_EXTENDED_ASSIGNMENT
      The number of bytes used for extended assignment
      Since:
      4.0
      See Also:
  • Constructor Details

    • ExtendedAssignment

      public ExtendedAssignment()
      Constructs an ExtendedAssignment object with all features defaulting to false.
      Since:
      4.0
    • ExtendedAssignment

      public ExtendedAssignment(int extendedAssignmentByte)
      Used internally by the ANT API to construct an ExtendedAssignment object from a byte.
      Parameters:
      extendedAssignmentByte - The byte representing the extended assignment configuration.
      Since:
      4.0
  • Method Details

    • getFlagsByte

      public byte getFlagsByte()
      Returns the byte representing the extended assignment configuration.
      Since:
      4.0
    • isEnabled

      public boolean isEnabled()
      Check if any features are set to enable.
      Returns:
      True if any extended assignment features are set.
      Since:
      4.0
    • getEnableBackgroundScanning

      public boolean getEnableBackgroundScanning()
      Returns the background scanning flag.
      Returns:
      True if background scanning is enabled. False, otherwise.
      Since:
      4.0
    • enableBackgroundScanning

      public void enableBackgroundScanning()
      Sets the enable background scanning flag.
      Since:
      4.1
    • getEnableFrequencyAgility

      public boolean getEnableFrequencyAgility()
      Returns the frequency agility flag.
      Returns:
      True, if frequency agility is enabled. False, otherwise.
      Since:
      4.0
    • enableFrequencyAgility

      public void enableFrequencyAgility()
      Sets the enable frequency agility flag.
      Since:
      4.1
    • getEnableFastChannelInitiation

      public boolean getEnableFastChannelInitiation()
      Returns the fast channel initiation flag.
      Returns:
      True, if fast channel initiation is enabled. False, if disabled or the ANT Radio Service version is less than 4.12.12.
      Since:
      4.12.12
    • enableFastChannelInitiation

      public void enableFastChannelInitiation()
      Sets the enable frequency agility flag. Note: Assigning a channel with this flag enabled on ANT Radio Service versions below 4.12.12 will throw an exception.
      Since:
      4.12.12
    • toString

      public String toString()
      Overrides:
      toString in class Object