DlTdoaRangingParams
public
final
class
DlTdoaRangingParams
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.ranging.uwb.DlTdoaRangingParams |
Class to represent UWB Downlink TDoA ranging parameters.
Summary
Nested classes | |
|---|---|
class |
DlTdoaRangingParams.Builder
Builder for |
Constants | |
|---|---|
int |
MEASUREMENT_VERSION_1
DL-TDoA Ranging Measurement version 1 |
int |
MEASUREMENT_VERSION_2
DL-TDoA Ranging Measurement version 2 |
int |
MEASUREMENT_VERSION_UNKNOWN
DL-TDoA Ranging Measurement version unknown |
Inherited constants |
|---|
Fields | |
|---|---|
public
static
final
Creator<DlTdoaRangingParams> |
CREATOR
|
Public methods | |
|---|---|
static
DlTdoaRangingParams
|
createFromFiraConfigPacket(byte[] config, byte[] rangingRoundIndexes)
Creates a |
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. |
UwbComplexChannel
|
getComplexChannel()
Gets the complex channel used for the session. |
UwbAddress
|
getDeviceAddress()
Gets the UWB address of the device. |
int
|
getMeasurementVersion()
Gets the measurement version. |
int
|
getRangingIntervalMillis()
Gets the ranging interval in milliseconds. |
byte[]
|
getRangingRoundIndexes()
Gets the active ranging round indexes. |
int
|
getSessionId()
Gets the session ID. |
byte[]
|
getSessionKeyInfo()
Gets the session key information. |
int
|
getSlotDuration()
Gets the slot duration. |
int
|
getSlotsPerRangingRound()
Gets the number of slots per ranging round. |
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 | |
|---|---|
Constants
MEASUREMENT_VERSION_1
public static final int MEASUREMENT_VERSION_1
DL-TDoA Ranging Measurement version 1
Constant Value: 1 (0x00000001)
MEASUREMENT_VERSION_2
public static final int MEASUREMENT_VERSION_2
DL-TDoA Ranging Measurement version 2
Constant Value: 2 (0x00000002)
MEASUREMENT_VERSION_UNKNOWN
public static final int MEASUREMENT_VERSION_UNKNOWN
DL-TDoA Ranging Measurement version unknown
Constant Value: 2147483647 (0x7fffffff)
Fields
Public methods
createFromFiraConfigPacket
public static DlTdoaRangingParams createFromFiraConfigPacket (byte[] config, byte[] rangingRoundIndexes)
Creates a DlTdoaRangingParams from a FiRa compliant configuration packet.
| Parameters | |
|---|---|
config |
byte: The byte array containing the FiRa configuration packet.
This value cannot be null. |
rangingRoundIndexes |
byte: The active ranging round indexes. If null, use the default
value of DlTdoaRangingParams.Builder. |
| Returns | |
|---|---|
DlTdoaRangingParams |
A DlTdoaRangingParams instance.
This value cannot be null. |
| Throws | |
|---|---|
IllegalArgumentException |
if the configuration packet is malformed or missing mandatory fields. |
See also:
ERROR(href="https://groups.firaconsortium.org/wg/FPSG/document/5944">FiRa Specific OOB Profile Advertisement Message for the configuration packet format./FiRa Specific OOB Profile Advertisement Message for the configuration packet format.)
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(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
|
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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. |
getComplexChannel
public UwbComplexChannel getComplexChannel ()
Gets the complex channel used for the session.
| Returns | |
|---|---|
UwbComplexChannel |
A UwbComplexChannel object containing channel and preamble index.
This value cannot be null. |
getDeviceAddress
public UwbAddress getDeviceAddress ()
Gets the UWB address of the device.
| Returns | |
|---|---|
UwbAddress |
The UwbAddress of the device.
This value cannot be null. |
getMeasurementVersion
public int getMeasurementVersion ()
Gets the measurement version.
| Returns | |
|---|---|
int |
The measurement version.
Value is one of the following: |
getRangingIntervalMillis
public int getRangingIntervalMillis ()
Gets the ranging interval in milliseconds.
| Returns | |
|---|---|
int |
The ranging interval in milliseconds. |
getRangingRoundIndexes
public byte[] getRangingRoundIndexes ()
Gets the active ranging round indexes.
| Returns | |
|---|---|
byte[] |
This value may be null. |
getSessionId
public int getSessionId ()
Gets the session ID.
| Returns | |
|---|---|
int |
The session ID as an integer. |
getSessionKeyInfo
public byte[] getSessionKeyInfo ()
Gets the session key information.
| Returns | |
|---|---|
byte[] |
A byte array containing session key info, or null if not available. |
getSlotDuration
public int getSlotDuration ()
Gets the slot duration.
| Returns | |
|---|---|
int |
The slot duration.
Value is one of the following: |
getSlotsPerRangingRound
public int getSlotsPerRangingRound ()
Gets the number of slots per ranging round.
| Returns | |
|---|---|
int |
The number of slots per ranging round. |
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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
String |
a string representation of the object. |
writeToParcel
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:
|
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.
Last updated 2026-02-26 UTC.