BleCsRangingParams


public final class BleCsRangingParams
extends Object implements Parcelable

java.lang.Object
   ↳ android.ranging.ble.cs.BleCsRangingParams


BleCsRangingParams encapsulates the parameters required for a bluetooth channel sounding ranging session.

Summary

Nested classes

class BleCsRangingParams.Builder

Builder class to create BleCsRangingParams instances. 

Constants

int LOCATION_TYPE_INDOOR

Location of the device is indoor.

int LOCATION_TYPE_OUTDOOR

Location of the device is outdoor.

int LOCATION_TYPE_UNKNOWN

Location of the device is unknown.

int SIGHT_TYPE_LINE_OF_SIGHT

Remote device is in line of sight.

int SIGHT_TYPE_NON_LINE_OF_SIGHT

Remote device is not in line of sight.

int SIGHT_TYPE_UNKNOWN

Sight type is unknown.

Inherited constants

Fields

public static final Creator<BleCsRangingParams> 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.

int getLocationType()

Returns the location type for the ranging session.

String getPeerBluetoothAddress()

Returns the Bluetooth address of the peer device.

int getRangingUpdateRate()

Returns the ranging update rate.

int getSecurityLevel()

Returns the security level for the ranging session.

int getSightType()

Returns the sight type for this ranging session.

int hashCode()

Returns a hash code value for the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

LOCATION_TYPE_INDOOR

Added in API level 36
public static final int LOCATION_TYPE_INDOOR

Location of the device is indoor.

Constant Value: 1 (0x00000001)

LOCATION_TYPE_OUTDOOR

Added in API level 36
public static final int LOCATION_TYPE_OUTDOOR

Location of the device is outdoor.

Constant Value: 2 (0x00000002)

LOCATION_TYPE_UNKNOWN

Added in API level 36
public static final int LOCATION_TYPE_UNKNOWN

Location of the device is unknown.

Constant Value: 0 (0x00000000)

SIGHT_TYPE_LINE_OF_SIGHT

Added in API level 36
public static final int SIGHT_TYPE_LINE_OF_SIGHT

Remote device is in line of sight.

Constant Value: 1 (0x00000001)

SIGHT_TYPE_NON_LINE_OF_SIGHT

Added in API level 36
public static final int SIGHT_TYPE_NON_LINE_OF_SIGHT

Remote device is not in line of sight.

Constant Value: 2 (0x00000002)

SIGHT_TYPE_UNKNOWN

Added in API level 36
public static final int SIGHT_TYPE_UNKNOWN

Sight type is unknown.

Constant Value: 0 (0x00000000)

Fields

CREATOR

Added in API level 36
public static final Creator<BleCsRangingParams> 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(android.os.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.

getLocationType

Added in API level 36
public int getLocationType ()

Returns the location type for the ranging session.

Returns
int the location type.
Value is one of the following:

getPeerBluetoothAddress

Added in API level 36
public String getPeerBluetoothAddress ()

Returns the Bluetooth address of the peer device.

Returns
String String representing the Bluetooth address.
This value cannot be null.

getRangingUpdateRate

Added in API level 36
public int getRangingUpdateRate ()

Returns the ranging update rate.

Returns
int ranging update rate.
Value is one of the following:

getSecurityLevel

Added in API level 36
public int getSecurityLevel ()

Returns the security level for the ranging session.

Returns
int the security level.
Value is one of the following:

getSightType

Added in API level 36
public int getSightType ()

Returns the sight type for this ranging session.

Returns
int the sight type.
Value is one of the following:

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.

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: