Added in API level 36

Summary: Inherited Constants | Fields | Methods | Inherited Methods

RangingData

Kotlin |Java

public final class RangingData
extends Object implements Parcelable

java.lang.Object
↳	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 interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<RangingData>`	`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.
`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.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 36

public static final Creator<RangingData> 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 `CONTENTS_FILE_DESCRIPTOR`

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.

getAzimuth

Added in API level 36

public RangingMeasurement getAzimuth ()

Returns the azimuth measurement, or null if not available.

Returns
`RangingMeasurement`	The `RangingMeasurement` representing the azimuth, or `null`.

getDistance

Added in API level 36

public RangingMeasurement getDistance ()

Returns the distance measurement.

Returns
`RangingMeasurement`	The `RangingMeasurement` representing the distance. This value may be `null`.

getDistanceStandardDeviationMeters

Added in version 36.1

public double getDistanceStandardDeviationMeters ()

Get the standard deviation of distance in meters .

Returned value will be positive if it exists

Returns
`double`	The standard deviation of distance in meters.

Throws
`IllegalStateException`	if distance standard deviation is not set.

getElevation

Added in API level 36

public RangingMeasurement getElevation ()

Returns the elevation measurement, or null if not available.

Returns
`RangingMeasurement`	The `RangingMeasurement` representing the elevation, or `null`.

getRangingTechnology

Added in API level 36

public int getRangingTechnology ()

Returns the ranging technology used.

Returns
`int`	The ranging technology as an integer. Value is one of the following: `RangingManager.UWB` `RangingManager.BLE_CS` `RangingManager.WIFI_NAN_RTT` `RangingManager.BLE_RSSI` `RangingManager.WIFI_STA_RTT`

getRssi

Added in API level 36

public int getRssi ()

Returns the RSSI (Received Signal Strength Indicator) value.

Returns
`int`	The RSSI value as an integer.

Throws
`IllegalStateException`	if rssi is not set.

getTimestampMillis

Added in API level 36

public long getTimestampMillis ()

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

Returns
`long`	The timestamp in milliseconds. Value is a non-negative timestamp in the `SystemClock.elapsedRealtime()` time base.

hasDistanceStandardDeviation

Added in version 36.1

public boolean hasDistanceStandardDeviation ()

Check if the standard deviation of distance is set.

Returns
`boolean`	True if a standard deviation value is set, false if it isn't.

hasRssi

Added in API level 36

public boolean hasRssi ()

Returns whether an RSSI measurement is included with the data.

Returns
`boolean`	The RSSI value as an integer.

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: `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`