public
final
class
GnssAntennaInfo
extends Object
implements
Parcelable
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 | ||||
|---|---|---|---|---|
|
From interface
|
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 |
GnssAntennaInfo.SphericalCorrections
|
getPhaseCenterVariationCorrections()
Returns a |
GnssAntennaInfo.SphericalCorrections
|
getSignalGainCorrections()
Returns a |
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 | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
| |||||||||||||||||||||||
|
From interface
| |||||||||||||||||||||||
Fields
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
The equals method for class Object implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x and
y, this method returns true if and only
if x and y refer to the same object
(x == y has the value true).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode method, which states
that equal objects must have equal hash codes.
| 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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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(Object)method, then calling thehashCodemethod 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(java.lang.Object)method, then calling thehashCodemethod 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.
As much as is reasonably practical, the hashCode method defined
by class Object does return distinct integers for
distinct objects. (The hashCode may or may not be implemented
as some function of an object's memory address at some point
in time.)
| 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. In general, the
toString method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
| 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 |