GnssAntennaInfo

Kotlin |Java

class GnssAntennaInfo : Parcelable

kotlin.Any
↳	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.

GnssAntennaInfo is returned per frequency band at the center frequency of the band.

Summary

Nested classes
	`Builder` Builder class for GnssAntennaInfo.
abstract	`Listener` Used for receiving GNSS antenna info from the GNSS engine.
	`PhaseCenterOffset` Class containing information about the antenna phase center offset (PCO).
	`SphericalCorrections` Represents corrections on a spherical mapping.

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()`
Boolean	`equals(other: Any?)`
Double	`getCarrierFrequencyMHz()` Returns the center frequency of the corresponding carrier frequency band.
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()`
String	`toString()`
Unit	`writeToParcel(parcel: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<GnssAntennaInfo!>	`CREATOR`

Public methods

describeContents

Added in API level 30

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 30

fun equals(other: Any?): Boolean

Parameters
`obj`	the reference object with which to compare.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getCarrierFrequencyMHz

Added in API level 30

fun getCarrierFrequencyMHz(): Double

Returns the center frequency of the corresponding carrier frequency band.

Return
`Double`	Value is 0.0f or greater

getPhaseCenterOffset

Added in API level 30

fun getPhaseCenterOffset(): GnssAntennaInfo.PhaseCenterOffset

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

Return
`GnssAntennaInfo.PhaseCenterOffset`	`PhaseCenterOffset` This value cannot be `null`.

getPhaseCenterVariationCorrections

Added in API level 30

fun getPhaseCenterVariationCorrections(): GnssAntennaInfo.SphericalCorrections?

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

Return
`GnssAntennaInfo.SphericalCorrections?`	phase center variation corrections as `SphericalCorrections` This value may be `null`.

getSignalGainCorrections

Added in API level 30

fun getSignalGainCorrections(): GnssAntennaInfo.SphericalCorrections?

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

Return
`GnssAntennaInfo.SphericalCorrections?`	signal gain corrections as `SphericalCorrections` This value may be `null`.

hashCode

Added in API level 30

fun hashCode(): Int

Return
`Int`	a hash code value for this object.

toString

Added in API level 30

fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 30

fun writeToParcel(
    parcel: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
`dest`	The Parcel in which the object should be written. 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 `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES
`parcel`	Parcel: This value cannot be `null`.

Properties

CREATOR

Added in API level 30

static val CREATOR: Parcelable.Creator<GnssAntennaInfo!>