GnssAntennaInfo.PhaseCenterOffset


public static final class GnssAntennaInfo.PhaseCenterOffset
extends Object implements Parcelable

java.lang.Object
   ↳ android.location.GnssAntennaInfo.PhaseCenterOffset


Class containing information about the antenna phase center offset (PCO). PCO is defined with respect to the origin of the Android sensor coordinate system, e.g., center of primary screen for mobiles - see sensor or form factor documents for details. Uncertainties are reported to 1-sigma.

Summary

Inherited constants

Fields

public static final Creator<GnssAntennaInfo.PhaseCenterOffset> CREATOR

Public constructors

PhaseCenterOffset(double offsetXMm, double offsetXUncertaintyMm, double offsetYMm, double offsetYUncertaintyMm, double offsetZMm, double offsetZUncertaintyMm)

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 getXOffsetMm()

Returns the x-axis offset of the phase center from the origin of the Android sensor coordinate system, in millimeters.

double getXOffsetUncertaintyMm()

Returns the 1-sigma uncertainty of the x-axis offset of the phase center from the origin of the Android sensor coordinate system, in millimeters.

double getYOffsetMm()

Returns the y-axis offset of the phase center from the origin of the Android sensor coordinate system, in millimeters.

double getYOffsetUncertaintyMm()

Returns the 1-sigma uncertainty of the y-axis offset of the phase center from the origin of the Android sensor coordinate system, in millimeters.

double getZOffsetMm()

Returns the z-axis offset of the phase center from the origin of the Android sensor coordinate system, in millimeters.

double getZOffsetUncertaintyMm()

Returns the 1-sigma uncertainty of the z-axis offset of the phase center from the origin of the Android sensor coordinate system, in millimeters.

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

Fields

CREATOR

Added in API level 30
public static final Creator<GnssAntennaInfo.PhaseCenterOffset> CREATOR

Public constructors

PhaseCenterOffset

Added in API level 30
public PhaseCenterOffset (double offsetXMm, 
                double offsetXUncertaintyMm, 
                double offsetYMm, 
                double offsetYUncertaintyMm, 
                double offsetZMm, 
                double offsetZUncertaintyMm)

Parameters
offsetXMm double

offsetXUncertaintyMm double

offsetYMm double

offsetYUncertaintyMm double

offsetZMm double

offsetZUncertaintyMm double

Public methods

describeContents

Added in API level 30
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(android.os.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

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

getXOffsetMm

Added in API level 30
public double getXOffsetMm ()

Returns the x-axis offset of the phase center from the origin of the Android sensor coordinate system, in millimeters.

Returns
double

getXOffsetUncertaintyMm

Added in API level 30
public double getXOffsetUncertaintyMm ()

Returns the 1-sigma uncertainty of the x-axis offset of the phase center from the origin of the Android sensor coordinate system, in millimeters.

Returns
double

getYOffsetMm

Added in API level 30
public double getYOffsetMm ()

Returns the y-axis offset of the phase center from the origin of the Android sensor coordinate system, in millimeters.

Returns
double

getYOffsetUncertaintyMm

Added in API level 30
public double getYOffsetUncertaintyMm ()

Returns the 1-sigma uncertainty of the y-axis offset of the phase center from the origin of the Android sensor coordinate system, in millimeters.

Returns
double

getZOffsetMm

Added in API level 30
public double getZOffsetMm ()

Returns the z-axis offset of the phase center from the origin of the Android sensor coordinate system, in millimeters.

Returns
double

getZOffsetUncertaintyMm

Added in API level 30
public double getZOffsetUncertaintyMm ()

Returns the 1-sigma uncertainty of the z-axis offset of the phase center from the origin of the Android sensor coordinate system, in millimeters.

Returns
double

hashCode

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

toString

Added in API level 30
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 30
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 Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES