Class Capabilities

java.lang.Object
com.dsi.ant.channel.Capabilities
All Implemented Interfaces:
android.os.Parcelable

public final class Capabilities extends Object implements android.os.Parcelable
Provides possible capabilities of an ANT channel.

See the ANT Message Protocol and Usage document for more details.

Since:
4.0
  • Field Details

    • CREATOR

      public static final android.os.Parcelable.Creator<Capabilities> CREATOR
      For Parcelable
  • Constructor Details

    • Capabilities

      public Capabilities()
      Constructs a Capabilities object with all capabilities default to false.
      Since:
      4.0
  • Method Details

    • hasRxMessageTimestamp

      public boolean hasRxMessageTimestamp()
      Checks for support of Rx message timestamp.
      Returns:
      true if channel supports Rx message timestamp, false otherwise.
      Since:
      4.0
    • supportRxMessageTimestamp

      public void supportRxMessageTimestamp(boolean value)
      Requests for channel that supports Rx message timestamp.
      Parameters:
      value - true to request channel that supports Rx message timestamp, false otherwise.
      Since:
      4.0
    • hasExtendedAssign

      public boolean hasExtendedAssign()
      Checks for support of extended assign, based on background scanning and frequency agility support.
      Returns:
      true if channel supports extended assign, false otherwise.
      Since:
      4.0
    • hasBackgroundScanning

      public boolean hasBackgroundScanning()
      Checks for support of background scanning.
      Returns:
      true if channel supports background scanning, false otherwise.
      Since:
      4.0
    • supportBackgroundScanning

      public void supportBackgroundScanning(boolean value)
      Requests for channel that supports background scanning.
      Parameters:
      value - true to request channel that supports background scanning, false otherwise.
      Since:
      4.0
    • hasFrequencyAgility

      public boolean hasFrequencyAgility()
      Checks for support of frequency agility.
      Returns:
      true if channel supports frequency agility, false otherwise.
      Since:
      4.0
    • supportFrequencyAgility

      public void supportFrequencyAgility(boolean value)
      Requests for channel that supports frequency agility.
      Parameters:
      value - true to request channel that supports frequency agility, false otherwise.
      Since:
      4.0
    • hasRssi

      public boolean hasRssi()
      Checks for support of RSSI.
      Returns:
      true if channel supports RSSI, false otherwise.
      Since:
      4.1
    • supportRssi

      public void supportRssi(boolean value)
      Requests for channel that supports RSSI value.
      Parameters:
      value - true to request channel that supports RSSI value, false otherwise.
      Since:
      4.1
    • hasWildcardIdList

      public boolean hasWildcardIdList()
      Checks for support of wildcard in inclusion/exclusion ID list.
      Returns:
      true if channel supports wildcard in in/exclusion ID list, false otherwise.
      Since:
      4.1
    • supportWildcardIdList

      public void supportWildcardIdList(boolean value)
      Requests for channel that supports wildcard in inclusion/exclusion ID list.
      Parameters:
      value - true to request channel that supports wildcard in in/exclusion ID list, false otherwise.
      Since:
      4.1
    • hasEventBuffering

      public boolean hasEventBuffering()
      Checks for support of configuring event buffer.
      Returns:
      true if channel supports configuring event buffer, false otherwise.
      Since:
      4.1
    • supportEventBuffering

      public void supportEventBuffering(boolean value)
      Requests for a channel that supports configuring event buffer.
      Parameters:
      value - true to request channel that supports configuring event buffer, false otherwise.
      Since:
      4.1
    • getMaxOutputPowerLevelSetting

      public int getMaxOutputPowerLevelSetting()
      Gets the highest output power level setting available (for transmit power).
      Returns:
      The highest output power level setting available (for transmit power)
      Since:
      4.0
    • getRfFrequencyMin

      public int getRfFrequencyMin()
      Gets the minimum value allowed for RF frequency.
      Returns:
      The minimum frequency allowed for this channel's communication as an offset in MHz from 2400MHz (2.4GHz)
      Since:
      4.1
    • getRfFrequencyMax

      public int getRfFrequencyMax()
      Gets the maximum value allowed for RF frequency.
      Returns:
      The maximum frequency allowed for this channel's communication as an offset in MHz from 2400MHz (2.4GHz)
      Since:
      4.1
    • hasSearchPriority

      public boolean hasSearchPriority()
      Checks for support of configuring channel search priority.
      Returns:
      true if channel supports configuring search priority, false otherwise.
      Since:
      4.7.3
    • supportSearchPriority

      public void supportSearchPriority(boolean value)
      Requests for a channel that supports configuring search priority.
      Parameters:
      value - true to request channel that supports configuring search priority,
      Since:
      4.7.3
    • hasFastChannelInitiation

      public boolean hasFastChannelInitiation()
      Checks for support of fast channel initiation.
      Returns:
      true if channel supports fast channel initiation, false otherwise.
      Since:
      4.12.12
    • supportFastChannelInitiation

      public void supportFastChannelInitiation(boolean value)
      Requests for a channel that supports fast channel initiation.
      Parameters:
      value - true to request channel that supports fast channel initiation, false otherwise.
      Since:
      4.12.12
    • hasSearchUplinkOptimization

      public boolean hasSearchUplinkOptimization()
      Checks for support of search uplink optimization.
      Returns:
      true if channel supports search uplink optimization, false otherwise.
      Since:
      4.12.13
    • supportSearchUplinkOptimization

      public void supportSearchUplinkOptimization(boolean value)
      Requests for channel that supports search uplink optimization. Search uplink allows the application to send a message during the search state and have it immediately sent on the first data message received (the one that triggers leaving search state), rather than the second data message received (in tracking state).
      Parameters:
      value - true to request channel that supports search uplink optimization, false otherwise.
      Since:
      4.12.13
    • hasCapabilities

      public boolean hasCapabilities(Capabilities desiredCapabilities)
      Checks for the desired capabilities.
      Parameters:
      desiredCapabilities - Has each capability to check for set.
      Returns:
      True if every capability set in the desired capabilities is also set in this capabilities instance. True if no desired capabilities provided.
      Since:
      4.0
    • numberOfCapabilities

      public int numberOfCapabilities(Capabilities desiredCapabilities)
      Checks for the number of desired capabilities.
      Parameters:
      desiredCapabilities - Has each capability to check for set.
      Returns:
      Number of capabilities set in the desired capabilities is also set in this capabilities instance. Zero if no desired capabilities provided.
      Since:
      4.0
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
      Since:
      4.0
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
      Since:
      4.0
    • toString

      public String toString()
      Overrides:
      toString in class Object
      Since:
      4.0
    • describeContents

      public int describeContents()
      Specified by:
      describeContents in interface android.os.Parcelable
    • writeToParcel

      public void writeToParcel(android.os.Parcel dest, int flags)
      Specified by:
      writeToParcel in interface android.os.Parcelable