RangingData | API reference | Android Developers

class RangingData : Parcelable

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.
RangingDataExtras?	`getRangingDataExtras()` Gets the extra ranging data associated with this ranging data.
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

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(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

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.

getDistanceStandardDeviationMeters

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.

getRangingTechnology

fun getRangingTechnology(): Int

Returns the ranging technology used.

Return
`Int`	The ranging technology as an integer.

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.

hasDistanceStandardDeviation

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.

fun hasRssi(): Boolean

Returns whether an RSSI measurement is included with the data.

Return
`Boolean`	The RSSI value as an integer.

hashCode

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

fun toString(): String

Returns a string representation of the object.

Return
`String`	a string representation of the object.

Properties

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.