ZElementExtension


class ZElementExtension : Parcelable
kotlin.Any
   ↳ android.ranging.DlTdoaMeasurement.ZElementExtension

Represents a Z-element extension regarding the height of a anchor.

Summary

Constants
static Int

The anchor location is expected to change.

static Int

The anchor location is not expected to change.

static Int

The anchor's movement patterns are unknown.

Inherited constants
Public methods
Int

Boolean
equals(other: Any?)

Double

Returns the anchor floor number.

Double

Returns the anchor height above floor.

Range<Double!>?

Returns the anchor height above floor range in meters with uncertainty.

Int

Returns the anchor height above floor uncertainty.

Int

Returns the expected to move.

Int

Boolean

Returns whether the anchor floor number is out of range.

Boolean

Returns whether the anchor height above floor is out of range.

String

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<DlTdoaMeasurement.ZElementExtension!>

Constants

MOVEMENT_EXPECTATION_MOVABLE

static val MOVEMENT_EXPECTATION_MOVABLE: Int

The anchor location is expected to change.

Value: 1

MOVEMENT_EXPECTATION_STATIONARY

static val MOVEMENT_EXPECTATION_STATIONARY: Int

The anchor location is not expected to change.

Value: 0

MOVEMENT_EXPECTATION_UNKNOWN

static val MOVEMENT_EXPECTATION_UNKNOWN: Int

The anchor's movement patterns are unknown.

Value: 2

Public methods

describeContents

fun describeContents(): Int

equals

fun equals(other: Any?): Boolean

getAnchorFloorNumber

fun getAnchorFloorNumber(): Double

Returns the anchor floor number.

The unit is floor and the resolution of this value is about 1/16 of a floor.

The highest floor number which can be represented is 8191/16 = (roughly) 512 floors.

The lowest floor number which can be represented is -8191/16 = (roughly) -512 floors.

The anchor floor number is unknown if the value is Double.NaN.

Return
Double the anchor floor number or Double.NaN if the anchor floor number is unknown.
Value is between -512.0f and 512.0f inclusive

getAnchorHeightAboveFloor

fun getAnchorHeightAboveFloor(): Double

Returns the anchor height above floor.

The unit is meter and the resolution of this value is about 1/4096 meter (0.24mm).

The highest anchor height above floor which can be represented is 8388607/4096 = (roughly) 2048 meters.

The lowest anchor height above floor which can be represented is -8388607/4096 = (roughly) -2048 meters.

The anchor height above floor is unknown if the value is Double.NaN.

Return
Double the anchor height above floor or Double.NaN if the anchor height above floor is unknown.
Value is between -2048.0f and 2048.0f inclusive

getAnchorHeightAboveFloorRange

fun getAnchorHeightAboveFloorRange(): Range<Double!>?

Returns the anchor height above floor range in meters with uncertainty.

If the anchor height above floor is unknown or the uncertainty is invalid, this value will be set to null.

getAnchorHeightAboveFloorUncertainty

fun getAnchorHeightAboveFloorUncertainty(): Int

Returns the anchor height above floor uncertainty.

An Anchor Height Above Floor Uncertainty value of 0 indicates an unknown anchor height above floor. Values 25 or higher are reserved. A value from 1 to 24 indicates that the actual anchor height above floor, a, is bounded according to:

h − 2 ^ (11 - u) <= a <= h + 2 ^ (11 - u)

where

h is the value in units of 1/4096 m of the anchor Height Above Floor field

u is the value of the Anchors Height Above Floor Uncertainty field

If the Anchor Height Above Floor field indicates an unknown anchor height above floor, the Anchor Height Above Floor Uncertainty field is set to 0.

Return
Int Value is between 0 and 24 inclusive

getExpectedToMove

fun getExpectedToMove(): Int

Returns the expected to move.

Return
Int Value is one of the following:

hashCode

fun hashCode(): Int

isAnchorFloorNumberOutOfRange

fun isAnchorFloorNumberOutOfRange(): Boolean

Returns whether the anchor floor number is out of range. If the value is out of range, the anchor floor number field is set to the closest boundary value, and this method returns true.

isAnchorHeightAboveFloorOutOfRange

fun isAnchorHeightAboveFloorOutOfRange(): Boolean

Returns whether the anchor height above floor is out of range. If the value is out of range, the anchor height above floor field is set to the closest boundary value, and this method returns true.

toString

fun toString(): String

writeToParcel

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