GnssAntennaInfo

public final class GnssAntennaInfo
extends Object implements Parcelable

java.lang.Object
   ↳ android.location.GnssAntennaInfo


A class that contains information about a GNSS antenna. GNSS antenna characteristics can change with device configuration, such as when a device is folded open or closed. Antenna information is delivered to registered instances of Listener.

Antenna info parameters are measured for each specific device model by the device manufacturers and provided to the Android framework.

Summary

Nested classes

class GnssAntennaInfo.Builder

Builder class for GnssAntennaInfo. 

interface GnssAntennaInfo.Listener

Used for receiving GNSS antenna info from the GNSS engine. 

class GnssAntennaInfo.PhaseCenterOffset

Class containing information about the antenna phase center offset (PCO). 

class GnssAntennaInfo.SphericalCorrections

Represents corrections on a spherical mapping. 

Inherited constants

Fields

public static final Creator<GnssAntennaInfo> 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 getCarrierFrequencyMHz()
GnssAntennaInfo.PhaseCenterOffset getPhaseCenterOffset()

Returns a PhaseCenterOffset object encapsulating the phase center offset and corresponding uncertainties in millimeters.

GnssAntennaInfo.SphericalCorrections getPhaseCenterVariationCorrections()

Returns a SphericalCorrections object encapsulating the phase center variation corrections and corresponding uncertainties in millimeters.

GnssAntennaInfo.SphericalCorrections getSignalGainCorrections()

Returns a SphericalCorrections object encapsulating the signal gain corrections and corresponding uncertainties in dBi.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel parcel, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

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

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.

getCarrierFrequencyMHz

Added in API level 30
public double getCarrierFrequencyMHz ()

Returns
double Value is 0.0f or greater

getPhaseCenterOffset

Added in API level 30
public GnssAntennaInfo.PhaseCenterOffset getPhaseCenterOffset ()

Returns a PhaseCenterOffset object encapsulating the phase center offset and corresponding uncertainties in millimeters.

Returns
GnssAntennaInfo.PhaseCenterOffset PhaseCenterOffset This value cannot be null.

getPhaseCenterVariationCorrections

Added in API level 30
public GnssAntennaInfo.SphericalCorrections getPhaseCenterVariationCorrections ()

Returns a SphericalCorrections object encapsulating the phase center variation corrections and corresponding uncertainties in millimeters.

Returns
GnssAntennaInfo.SphericalCorrections phase center variation corrections as SphericalCorrections This value may be null.

getSignalGainCorrections

Added in API level 30
public GnssAntennaInfo.SphericalCorrections getSignalGainCorrections ()

Returns a SphericalCorrections object encapsulating the signal gain corrections and corresponding uncertainties in dBi.

Returns
GnssAntennaInfo.SphericalCorrections signal gain corrections as SphericalCorrections This value may be null.

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 parcel, 
                int flags)

Flatten this object in to a Parcel.

Parameters
parcel 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