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

DlTdoaMeasurement.ZElementExtension

---

Kotlin |Java

public static final class DlTdoaMeasurement.ZElementExtension
extends Object implements Parcelable

java.lang.Object
↳	android.ranging.DlTdoaMeasurement.ZElementExtension

---

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

Summary

Constants
int	MOVEMENT_EXPECTATION_MOVABLE The anchor location is expected to change.
int	MOVEMENT_EXPECTATION_STATIONARY The anchor location is not expected to change.
int	MOVEMENT_EXPECTATION_UNKNOWN The anchor's movement patterns are unknown.

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<DlTdoaMeasurement.ZElementExtension>	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.
double	getAnchorFloorNumber() Returns the anchor floor number.
double	getAnchorHeightAboveFloor() Returns the anchor height above floor.
Range<Double>	getAnchorHeightAboveFloorRange() Returns the anchor height above floor range in meters with uncertainty.
int	getAnchorHeightAboveFloorUncertainty() Returns the anchor height above floor uncertainty.
int	getExpectedToMove() Returns the expected to move.
int	hashCode() Returns a hash code value for the object.
boolean	isAnchorFloorNumberOutOfRange() Returns whether the anchor floor number is out of range.
boolean	isAnchorHeightAboveFloorOutOfRange() Returns whether the anchor height above floor is out of range.
String	toString() Returns a string representation of the object.
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 timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
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

MOVEMENT_EXPECTATION_MOVABLE

public static final int MOVEMENT_EXPECTATION_MOVABLE

The anchor location is expected to change.

Constant Value: 1 (0x00000001)

MOVEMENT_EXPECTATION_STATIONARY

public static final int MOVEMENT_EXPECTATION_STATIONARY

The anchor location is not expected to change.

Constant Value: 0 (0x00000000)

MOVEMENT_EXPECTATION_UNKNOWN

public static final int MOVEMENT_EXPECTATION_UNKNOWN

The anchor's movement patterns are unknown.

Constant Value: 2 (0x00000002)

Fields

CREATOR

public static final Creator<DlTdoaMeasurement.ZElementExtension> 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(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.

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.

getAnchorFloorNumber

public double getAnchorFloorNumber ()

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.

Returns
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

public double getAnchorHeightAboveFloor ()

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.

Returns
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

public Range<Double> getAnchorHeightAboveFloorRange ()

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.

Returns
Range<Double>

getAnchorHeightAboveFloorUncertainty

public int getAnchorHeightAboveFloorUncertainty ()

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 \u2212 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.

Returns
int	Value is between 0 and 24 inclusive

getExpectedToMove

public int getExpectedToMove ()

Returns the expected to move.

Returns
int	Value is one of the following: MOVEMENT_EXPECTATION_STATIONARY MOVEMENT_EXPECTATION_MOVABLE MOVEMENT_EXPECTATION_UNKNOWN

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 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.

Returns
int	a hash code value for this object.

isAnchorFloorNumberOutOfRange

public boolean isAnchorFloorNumberOutOfRange ()

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.

Returns
boolean

isAnchorHeightAboveFloorOutOfRange

public boolean isAnchorHeightAboveFloorOutOfRange ()

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.

Returns
boolean

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: Parcelable.PARCELABLE_WRITE_RETURN_VALUE