Added in API level 36

RangingData

---

Kotlin |Java

class RangingData : Parcelable

kotlin.Any
↳	android.ranging.RangingData

Represents ranging data, including distance, azimuth, elevation, and RSSI measurements, along with the ranging technology used and a timestamp.

Summary

Inherited constants

From class Parcelable Int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. Int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Boolean	equals(other: Any?) Indicates whether some other object is "equal to" this one.
RangingMeasurement?	getAzimuth() Returns the azimuth measurement, or null if not available.
RangingMeasurement?	getDistance() Returns the distance measurement.
Double	getDistanceStandardDeviationMeters() Get the standard deviation of distance in meters .
RangingMeasurement?	getElevation() Returns the elevation measurement, or null if not available.
Int	getRangingTechnology() Returns the ranging technology used.
Int	getRssi() Returns the RSSI (Received Signal Strength Indicator) value.
Long	getTimestampMillis() Returns the timestamp of when the ranging data was collected.
Boolean	hasDistanceStandardDeviation() Check if the standard deviation of distance is set.
Boolean	hasRssi() Returns whether an RSSI measurement is included with the data.
Int	hashCode() Returns a hash code value for the object.
String	toString() Returns a string representation of the object.
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<RangingData!>	CREATOR

Public methods

describeContents

Added in API level 36

fun describeContents(): Int

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.

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

equals

Added in API level 36

fun equals(other: Any?): Boolean

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
obj	the reference object with which to compare.

Return
Boolean	true if this object is the same as the obj argument; false otherwise.

getAzimuth

Added in API level 36

fun getAzimuth(): RangingMeasurement?

Returns the azimuth measurement, or null if not available.

Return
RangingMeasurement?	The RangingMeasurement representing the azimuth, or null.

getDistance

Added in API level 36

fun getDistance(): RangingMeasurement?

Returns the distance measurement.

Return
RangingMeasurement?	The RangingMeasurement representing the distance. This value may be null.

getDistanceStandardDeviationMeters

Added in API level 36.1

fun getDistanceStandardDeviationMeters(): Double

Get the standard deviation of distance in meters .

Returned value will be positive if it exists

Return
Double	The standard deviation of distance in meters.

Exceptions
java.lang.IllegalStateException	if distance standard deviation is not set.

getElevation

Added in API level 36

fun getElevation(): RangingMeasurement?

Returns the elevation measurement, or null if not available.

Return
RangingMeasurement?	The RangingMeasurement representing the elevation, or null.

getRangingTechnology

Added in API level 36

fun getRangingTechnology(): Int

Returns the ranging technology used.

Return
Int	The ranging technology as an integer. Value is one of the following: android.ranging.RangingManager#UWB android.ranging.RangingManager#BLE_CS android.ranging.RangingManager#WIFI_NAN_RTT android.ranging.RangingManager#BLE_RSSI android.ranging.RangingManager#WIFI_STA_RTT

getRssi

Added in API level 36

fun getRssi(): Int

Returns the RSSI (Received Signal Strength Indicator) value.

Return
Int	The RSSI value as an integer.

Exceptions
java.lang.IllegalStateException	if rssi is not set.

getTimestampMillis

Added in API level 36

fun getTimestampMillis(): Long

Returns the timestamp of when the ranging data was collected.
Value is a non-negative timestamp in the android.os.SystemClock#elapsedRealtime() time base.

Return
Long	The timestamp in milliseconds. Value is a non-negative timestamp in the android.os.SystemClock#elapsedRealtime() time base.

hasDistanceStandardDeviation

Added in API level 36.1

fun hasDistanceStandardDeviation(): Boolean

Check if the standard deviation of distance is set.

Return
Boolean	True if a standard deviation value is set, false if it isn't.

hasRssi

Added in API level 36

fun hasRssi(): Boolean

Returns whether an RSSI measurement is included with the data.

Return
Boolean	The RSSI value as an integer.

hashCode

Added in API level 36

fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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.

Return
Int	a hash code value for this object.

toString

Added in API level 36

fun toString(): String

Returns a string representation of the object.

Return
String	a string representation of the object.

writeToParcel

Added in API level 36

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: PARCELABLE_WRITE_RETURN_VALUE

Properties

CREATOR

Added in API level 36

static val CREATOR: Parcelable.Creator<RangingData!>