DlTdoaMeasurement

MESSAGE_TYPE_FINAL_DTM

static val MESSAGE_TYPE_FINAL_DTM: Int

DL-TDoA Message Type: Final DTM

Value: 2

MESSAGE_TYPE_POLL_DTM

static val MESSAGE_TYPE_POLL_DTM: Int

DL-TDoA Message Type: Poll DTM

Value: 0

MESSAGE_TYPE_RESPONSE_DTM

static val MESSAGE_TYPE_RESPONSE_DTM: Int

DL-TDoA Message Type: Response DTM

Value: 1

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.

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.

getActiveRangingRoundIndexes

fun getActiveRangingRoundIndexes(): MutableList<Int!>

Returns a list of active ranging round indexes.

These are the rounds in which the DT-Anchor associated with this measurement result is present.

getAnchorCfo

fun getAnchorCfo(): Float

Returns the Clock Frequency Offset (CFO) of a Responder DT-Anchor.

This offset is relative to the Initiator DT-Anchor of the ranging round, in ppm units.

getAnchorLocation

fun getAnchorLocation(): DlTdoaMeasurement.AnchorLocation?

Returns the anchor location, if available.

getAoaAzimuth

fun getAoaAzimuth(): Float

Returns the Angle of Arrival (AoA) azimuth in degrees.

This value ranges from -180 to 180 degrees. If the value is not available, it returns Float.NaN.

getAoaAzimuthFom

fun getAoaAzimuthFom(): Int

Returns the Figure of Merit (FoM) of the AoA azimuth.

This value ranges from 0 to 100. If the value is not available, it returns 0.

getAoaElevation

fun getAoaElevation(): Float

Returns the Angle of Arrival (AoA) elevation in degrees.

This value ranges from -90 to 90 degrees. If the value is not available, it returns Float.NaN.

getAoaElevationFom

fun getAoaElevationFom(): Int

Returns the Figure of Merit (FoM) of the AoA elevation.

This value ranges from 0 to 100. If the value is not available, it returns 0.

getBlockIndex

fun getBlockIndex(): Int

Returns the block index of the current ranging block.

This identifies the specific ranging block during which the measurement occurred.

getCfo

fun getCfo(): Float

Returns the locally measured Clock Frequency Offset (CFO) by the DT-Tag.

This offset is relative to the DT-Anchor that sent the message, in ppm units.

getInitiatorReplyTime

fun getInitiatorReplyTime(): Long

Returns the time difference measured by the Initiator DT-Anchor.

It's between the RX timestamp of a Responder's DTM and the TX timestamp of the Final DTM, in Ranging Ticks (~15.65 ps). If the ranging method SS-TWR is used between DT-Anchors, then there is no Final DTM at all and this value is 0.

getInitiatorResponderTof

fun getInitiatorResponderTof(): Int

Returns the Time of Flight (ToF) between the Responder and Initiator DT-Anchors.

This is measured by the Responder DT-Anchor, in Ranging Ticks (~15.65 ps). This field is only valid for the Response DTM. For Poll DTM and Final DTM, this value is 0.

getMeasurementVersion

fun getMeasurementVersion(): Int

Returns the measurement version.

getMessageControl

fun getMessageControl(): Int

Returns the raw MessageControl field.

Note: This is an advanced-use field. The value is a bitmask constructed according to the layout described in the FiRa 4.0 UCI specification mentioned in the DlTdoaMeasurement class documentation. The representation is version-specific and depends on the measurement version (see Table 31 for v1, and Table 32 for v2).

getMessageType

fun getMessageType(): Int

Returns the message type of the received DL-TDoA Message (DTM).

getNlos

fun getNlos(): Int

Returns an indicator of the Line of Sight (LoS) status.

getResponderReplyTime

fun getResponderReplyTime(): Long

Returns the time difference measured at the Responder DT-Anchor.

It's between the RX timestamp of the Poll DTM and the TX timestamp of its Response DTM, in Ranging Ticks (~15.65 ps). For Poll DTM and Final DTM, this value is 0.

getRoundIndex

fun getRoundIndex(): Int

Returns the round index of the current ranging round within the current ranging block.

This specifies the active ranging round.

getRssi

fun getRssi(): Int

Returns the Received Signal Strength Indicator (RSSI) in dBm.

This value ranges from -127dBm to -1dBm. If the value is not available, it returns 0.

getRxTimestamp

fun getRxTimestamp(): ByteArray

Returns the local reception timestamp of the message by the DT-Tag (Android device).

This timestamp is measured locally in Ranging Ticks (~15.65 ps).

getSuperclusterId

fun getSuperclusterId(): Int

Returns the Supercluster ID, if available.

If this value is available, Supercluster common timebase is valid for Initiator DT-Anchors using the same Supercluster ID.

getTxTimestamp

fun getTxTimestamp(): ByteArray

Returns the transmission timestamp of the message reported by the DT-Anchor.

This timestamp is in Ranging Ticks (~15.65 ps).

hasSuperclusterId

fun hasSuperclusterId(): Boolean

Returns true if Supercluster ID is present.

If this value is available, Supercluster common timebase is valid for Initiator DT-Anchors using the same Supercluster ID.

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.

isTxTimestampInCommonTimeBase

fun isTxTimestampInCommonTimeBase(): Boolean

Returns true if TX timestamp is based on a common time base.

This value is derived from bit 0 of the MessageControl field. If TX timestamp is not based on a common time base, it is based on the local time base and cannot be used for localization.

toString

fun toString(): String

Returns a string representation of the object.

writeToParcel

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

CREATOR

static val CREATOR: Parcelable.Creator<DlTdoaMeasurement!>