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()`
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.
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

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

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 `android.ranging.RangingManager#UWB`, `android.ranging.RangingManager#BLE_CS`, `android.ranging.RangingManager#WIFI_NAN_RTT`, `android.ranging.RangingManager#BLE_RSSI`, or `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 measured as the number of milliseconds since 1970-01-01T00:00:00Z.

Return
`Long`	The timestamp in milliseconds. Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.

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.

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 `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 36

static val CREATOR: Parcelable.Creator<RangingData!>