Most visited

Recently visited

Results for

Summary: Constants | Inherited Constants | Fields | Methods | Inherited Methods

RangingResult

public final class RangingResult
extends Object implements Parcelable

java.lang.Object
↳	android.net.wifi.rtt.RangingResult

Ranging result for a request started by WifiRttManager#startRanging(RangingRequest, java.util.concurrent.Executor, RangingResultCallback). Results are returned in RangingResultCallback#onRangingResults(List).

A ranging result is the distance measurement result for a single device specified in the RangingRequest.

Summary

Constants
`int`	`STATUS_FAIL` Individual range request status, `getStatus()`.
`int`	`STATUS_RESPONDER_DOES_NOT_SUPPORT_IEEE80211MC` Individual range request status, `getStatus()`.
`int`	`STATUS_SUCCESS` Individual range request status, `getStatus()`.

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<RangingResult>`	`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`	`getDistanceMm()`
`int`	`getDistanceStdDevMm()`
`MacAddress`	`getMacAddress()`
`int`	`getNumAttemptedMeasurements()`
`int`	`getNumSuccessfulMeasurements()`
`PeerHandle`	`getPeerHandle()`
`long`	`getRangingTimestampMillis()`
`int`	`getRssi()`
`int`	`getStatus()`
`ResponderLocation`	`getUnverifiedResponderLocation()`
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`is80211mcMeasurement()`
`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 timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

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.

Constants

STATUS_FAIL

public static final int STATUS_FAIL

Individual range request status, getStatus(). Indicates ranging operation failed and the distance value is invalid.

Constant Value: 1 (0x00000001)

STATUS_RESPONDER_DOES_NOT_SUPPORT_IEEE80211MC

public static final int STATUS_RESPONDER_DOES_NOT_SUPPORT_IEEE80211MC

Individual range request status, getStatus(). Indicates that the ranging operation failed because the specified peer does not support IEEE 802.11mc RTT operations. Support by an Access Point can be confirmed using ScanResult.is80211mcResponder().

On such a failure, the individual result fields of RangingResult such as RangingResult#getDistanceMm() are invalid.

Constant Value: 2 (0x00000002)

STATUS_SUCCESS

public static final int STATUS_SUCCESS

Individual range request status, getStatus(). Indicates ranging operation was successful and distance value is valid.

Constant Value: 0 (0x00000000)

Fields

CREATOR

public static final Creator<RangingResult> CREATOR

Public methods

describeContents

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

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

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.

getDistanceMm

public int getDistanceMm ()

Returns

Returns
`int`	The distance (in mm) to the device specified by `getMacAddress()` or `getPeerHandle()`. Note: the measured distance may be negative for very close devices. Only valid if `getStatus()` returns `STATUS_SUCCESS`, otherwise will throw an exception.

int

The distance (in mm) to the device specified by getMacAddress() or getPeerHandle().

Note: the measured distance may be negative for very close devices.

Only valid if getStatus() returns STATUS_SUCCESS, otherwise will throw an exception.

getDistanceStdDevMm

public int getDistanceStdDevMm ()

Returns

Returns
`int`	The standard deviation of the measured distance (in mm) to the device specified by `getMacAddress()` or `getPeerHandle()`. The standard deviation is calculated over the measurements executed in a single RTT burst. The number of measurements is returned by `getNumSuccessfulMeasurements()` - 0 successful measurements indicate that the standard deviation is not valid (a valid standard deviation requires at least 2 data points). Only valid if `getStatus()` returns `STATUS_SUCCESS`, otherwise will throw an exception.

int

The standard deviation of the measured distance (in mm) to the device specified by getMacAddress() or getPeerHandle(). The standard deviation is calculated over the measurements executed in a single RTT burst. The number of measurements is returned by getNumSuccessfulMeasurements() - 0 successful measurements indicate that the standard deviation is not valid (a valid standard deviation requires at least 2 data points).

Only valid if getStatus() returns STATUS_SUCCESS, otherwise will throw an exception.

getMacAddress

public MacAddress getMacAddress ()

Returns
`MacAddress`	The MAC address of the device whose range measurement was requested. Will correspond to the MAC address of the device in the `RangingRequest`. Will return a `null` for results corresponding to requests issued using a `PeerHandle`, i.e. using the `RangingRequest.Builder#addWifiAwarePeer(PeerHandle)` API.

getNumAttemptedMeasurements

public int getNumAttemptedMeasurements ()

Returns

Returns
`int`	The number of attempted measurements used in the RTT exchange resulting in this set of results. The number of successful measurements is returned by `getNumSuccessfulMeasurements()` which at most, if there are no errors, will be 1 less than the number of attempted measurements. Only valid if `getStatus()` returns `STATUS_SUCCESS`, otherwise will throw an exception. If the value is 0, it should be interpreted as no information available, which may occur for one-sided RTT measurements. Instead `RangingRequest#getRttBurstSize()` should be used instead.

int

The number of attempted measurements used in the RTT exchange resulting in this set of results. The number of successful measurements is returned by getNumSuccessfulMeasurements() which at most, if there are no errors, will be 1 less than the number of attempted measurements.

Only valid if getStatus() returns STATUS_SUCCESS, otherwise will throw an exception. If the value is 0, it should be interpreted as no information available, which may occur for one-sided RTT measurements. Instead RangingRequest#getRttBurstSize() should be used instead.

getNumSuccessfulMeasurements

public int getNumSuccessfulMeasurements ()

Returns

Returns
`int`	The number of successful measurements used to calculate the distance and standard deviation. If the number of successful measurements if 1 then then standard deviation, returned by `getDistanceStdDevMm()`, is not valid (a 0 is returned for the standard deviation). The total number of measurement attempts is returned by `getNumAttemptedMeasurements()`. The number of successful measurements will be at most 1 less then the number of attempted measurements. Only valid if `getStatus()` returns `STATUS_SUCCESS`, otherwise will throw an exception.

int

The number of successful measurements used to calculate the distance and standard deviation. If the number of successful measurements if 1 then then standard deviation, returned by getDistanceStdDevMm(), is not valid (a 0 is returned for the standard deviation).

The total number of measurement attempts is returned by getNumAttemptedMeasurements(). The number of successful measurements will be at most 1 less then the number of attempted measurements.

Only valid if getStatus() returns STATUS_SUCCESS, otherwise will throw an exception.

getPeerHandle

public PeerHandle getPeerHandle ()

Returns
`PeerHandle`	The PeerHandle of the device whose reange measurement was requested. Will correspond to the PeerHandle of the devices requested using `RangingRequest.Builder#addWifiAwarePeer(PeerHandle)`. Will return a `null` for results corresponding to requests issued using a MAC address.

getRangingTimestampMillis

public long getRangingTimestampMillis ()

Returns
`long`	The timestamp at which the ranging operation was performed. The timestamp is in milliseconds since boot, including time spent in sleep, corresponding to values provided by `SystemClock.elapsedRealtime()`. Only valid if `getStatus()` returns `STATUS_SUCCESS`, otherwise will throw an exception.

getRssi

public int getRssi ()

Returns
`int`	The average RSSI, in units of dBm, observed during the RTT measurement. Only valid if `getStatus()` returns `STATUS_SUCCESS`, otherwise will throw an exception.

getStatus

public int getStatus ()

Returns
`int`	The status of ranging measurement: `STATUS_SUCCESS` in case of success, and `STATUS_FAIL` in case of failure. Value is `STATUS_SUCCESS`, `STATUS_FAIL`, or `STATUS_RESPONDER_DOES_NOT_SUPPORT_IEEE80211MC`

getUnverifiedResponderLocation

public ResponderLocation getUnverifiedResponderLocation ()

Returns

Returns
`ResponderLocation`	The unverified responder location represented as `ResponderLocation` which captures location information the responder is programmed to broadcast. The responder location is referred to as unverified, because we are relying on the device/site administrator to correctly configure its location data. Will return a `null` when the location information cannot be parsed. Only valid if `getStatus()` returns `STATUS_SUCCESS`, otherwise will throw an exception.

ResponderLocation

The unverified responder location represented as ResponderLocation which captures location information the responder is programmed to broadcast. The responder location is referred to as unverified, because we are relying on the device/site administrator to correctly configure its location data.

Will return a null when the location information cannot be parsed.

Only valid if getStatus() returns STATUS_SUCCESS, otherwise will throw an exception.

hashCode

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(Object) 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(java.lang.Object) 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
`int`	a hash code value for this object.

is80211mcMeasurement

public boolean is80211mcMeasurement ()

Returns
`boolean`	The result is true if the IEEE 802.11mc protocol was used (also known as two-sided RTT). If the result is false, a one-side RTT result is provided which does not subtract the turnaround time at the responder. Only valid if `getStatus()` returns `STATUS_SUCCESS`, otherwise will throw an exception.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: The Parcel in which the object should be written.
`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 `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES