RangingCapabilities


public final class RangingCapabilities
extends Object implements Parcelable

java.lang.Object
   ↳ android.ranging.RangingCapabilities


Represents the capabilities and availability of various ranging technologies.

The RangingCapabilities class encapsulates the status of different ranging technologies. It also allows querying the availability of other ranging technologies through a mapping of technology identifiers to availability statuses.

Summary

Constants

int DISABLED_REGULATORY

Indicates that the ranging technology is disabled due to regulatory restrictions.

int DISABLED_USER

Indicates that the ranging technology is disabled by the user.

int DISABLED_USER_RESTRICTIONS

Indicates that the ranging technology is disabled due to device usage restrictions.

int ENABLED

Indicates that the ranging technology is enabled and available for use.

int NOT_SUPPORTED

Indicates that the ranging technology is not supported on the current device.

Inherited constants

Fields

public static final Creator<RangingCapabilities> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

BleCsRangingCapabilities getCsCapabilities()

Gets the BLE channel sounding ranging capabilities.

RttRangingCapabilities getRttRangingCapabilities()

Gets the WiFi NAN-RTT ranging capabilities.

Map<IntegerInteger> getTechnologyAvailability()

Gets a map containing the availability of various ranging technologies.

UwbRangingCapabilities getUwbCapabilities()

Gets the UWB ranging capabilities.

WifiPdRangingCapabilities getWifiPdRangingCapabilities()

Gets the WiFi PD ranging capabilities.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

DISABLED_REGULATORY

Added in API level 36
public static final int DISABLED_REGULATORY

Indicates that the ranging technology is disabled due to regulatory restrictions.

Constant Value: 2 (0x00000002)

DISABLED_USER

Added in API level 36
public static final int DISABLED_USER

Indicates that the ranging technology is disabled by the user.

Constant Value: 1 (0x00000001)

DISABLED_USER_RESTRICTIONS

Added in API level 36
public static final int DISABLED_USER_RESTRICTIONS

Indicates that the ranging technology is disabled due to device usage restrictions.

Constant Value: 4 (0x00000004)

ENABLED

Added in API level 36
public static final int ENABLED

Indicates that the ranging technology is enabled and available for use.

Constant Value: 3 (0x00000003)

NOT_SUPPORTED

Added in API level 36
public static final int NOT_SUPPORTED

Indicates that the ranging technology is not supported on the current device.

Constant Value: 0 (0x00000000)

Fields

CREATOR

Added in API level 36
public static final Creator<RangingCapabilities> CREATOR

Public methods

describeContents

Added in API level 36
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
Value is either 0 or

equals

Added in API level 36
public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getCsCapabilities

Added in API level 36
public BleCsRangingCapabilities getCsCapabilities ()

Gets the BLE channel sounding ranging capabilities.

Returns
BleCsRangingCapabilities a BleCsRangingCapabilities object or null if not available.

getRttRangingCapabilities

Added in API level 36
public RttRangingCapabilities getRttRangingCapabilities ()

Gets the WiFi NAN-RTT ranging capabilities.

Returns
RttRangingCapabilities a RttRangingCapabilities object or null if not available.

getTechnologyAvailability

Added in API level 36
public Map<IntegerInteger> getTechnologyAvailability ()

Gets a map containing the availability of various ranging technologies.

The map uses technology identifiers as keys and their respective availability statuses as values.

Returns
Map<IntegerInteger> a Map with key ERROR(RangingTechnology/android.ranging.RangingManager.RangingTechnology RangingTechnology) and value ERROR(RangingTechnologyAvailability/android.ranging.RangingCapabilities.RangingTechnologyAvailability RangingTechnologyAvailability).
This value cannot be null.

getUwbCapabilities

Added in API level 36
public UwbRangingCapabilities getUwbCapabilities ()

Gets the UWB ranging capabilities.

Returns
UwbRangingCapabilities a UwbRangingCapabilities object or null if not available.

getWifiPdRangingCapabilities

Added in API level 37
public WifiPdRangingCapabilities getWifiPdRangingCapabilities ()

Gets the WiFi PD ranging capabilities.

Returns
WifiPdRangingCapabilities a WifiPdRangingCapabilities object or null if not available.

hashCode

Added in API level 36
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int a hash code value for this object.

toString

Added in API level 36
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 36
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.
Value is either 0 or a combination of the following: