Added in API level 37

DlTdoaRangingParams


class DlTdoaRangingParams : Parcelable
kotlin.Any
   ↳ android.ranging.uwb.DlTdoaRangingParams

Class to represent UWB Downlink TDoA ranging parameters.

Summary

Nested classes

Builder for DlTdoaRangingParams.

Constants
static Int

DL-TDoA Ranging Measurement version 1

static Int

DL-TDoA Ranging Measurement version 2

static Int

DL-TDoA Ranging Measurement version unknown

Inherited constants
Public methods
static DlTdoaRangingParams
createFromFiraConfigPacket(config: ByteArray, rangingRoundIndexes: ByteArray?)

Creates a DlTdoaRangingParams from a FiRa compliant configuration packet.

Int

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.

UwbComplexChannel

Gets the complex channel used for the session.

UwbAddress

Gets the UWB address of the device.

Int

Gets the measurement version.

Int

Gets the ranging interval in milliseconds.

ByteArray?

Gets the active ranging round indexes.

Int

Gets the session ID.

ByteArray?

Gets the session key information.

Int

Gets the slot duration.

Int

Gets the number of slots per ranging round.

Int

Returns a hash code value for the object.

String

Returns a string representation of the object.

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<DlTdoaRangingParams!>

Constants

MEASUREMENT_VERSION_1

Added in API level 37
static val MEASUREMENT_VERSION_1: Int

DL-TDoA Ranging Measurement version 1

Value: 1

MEASUREMENT_VERSION_2

Added in API level 37
static val MEASUREMENT_VERSION_2: Int

DL-TDoA Ranging Measurement version 2

Value: 2

MEASUREMENT_VERSION_UNKNOWN

Added in API level 37
static val MEASUREMENT_VERSION_UNKNOWN: Int

DL-TDoA Ranging Measurement version unknown

Value: 2147483647

Public methods

createFromFiraConfigPacket

Added in API level 37
static fun createFromFiraConfigPacket(
    config: ByteArray,
    rangingRoundIndexes: ByteArray?
): DlTdoaRangingParams

Creates a DlTdoaRangingParams from a FiRa compliant configuration packet.

Parameters
config ByteArray: The byte array containing the FiRa configuration packet.
This value cannot be null.
rangingRoundIndexes ByteArray?: The active ranging round indexes. If null, use the default value of DlTdoaRangingParams.Builder.
Return
DlTdoaRangingParams A DlTdoaRangingParams instance.
This value cannot be null.
Exceptions
java.lang.IllegalArgumentException if the configuration packet is malformed or missing mandatory fields.

See Also

    describeContents

    Added in API level 37
    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

    equals

    Added in API level 37
    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.

    getComplexChannel

    Added in API level 37
    fun getComplexChannel(): UwbComplexChannel

    Gets the complex channel used for the session.

    Return
    UwbComplexChannel A UwbComplexChannel object containing channel and preamble index.
    This value cannot be null.

    getDeviceAddress

    Added in API level 37
    fun getDeviceAddress(): UwbAddress

    Gets the UWB address of the device.

    Return
    UwbAddress The UwbAddress of the device.
    This value cannot be null.

    getMeasurementVersion

    Added in API level 37
    fun getMeasurementVersion(): Int

    Gets the measurement version.

    Return
    Int The measurement version.
    Value is one of the following:

    getRangingIntervalMillis

    Added in API level 37
    fun getRangingIntervalMillis(): Int

    Gets the ranging interval in milliseconds.

    Return
    Int The ranging interval in milliseconds.

    getRangingRoundIndexes

    Added in API level 37
    fun getRangingRoundIndexes(): ByteArray?

    Gets the active ranging round indexes.

    Return
    ByteArray? This value may be null.

    getSessionId

    Added in API level 37
    fun getSessionId(): Int

    Gets the session ID.

    Return
    Int The session ID as an integer.

    getSessionKeyInfo

    Added in API level 37
    fun getSessionKeyInfo(): ByteArray?

    Gets the session key information.

    Return
    ByteArray? A byte array containing session key info, or null if not available.

    getSlotDuration

    Added in API level 37
    fun getSlotDuration(): Int

    Gets the slot duration.

    Return
    Int The slot duration.
    Value is one of the following:

    getSlotsPerRangingRound

    Added in API level 37
    fun getSlotsPerRangingRound(): Int

    Gets the number of slots per ranging round.

    Return
    Int The number of slots per ranging round.

    hashCode

    Added in API level 37
    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

    Added in API level 37
    fun toString(): String

    Returns a string representation of the object.

    Return
    String a string representation of the object.

    writeToParcel

    Added in API level 37
    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 the following:

    Properties

    CREATOR

    Added in API level 37
    static val CREATOR: Parcelable.Creator<DlTdoaRangingParams!>