GnssAutomaticGainControl
class GnssAutomaticGainControl : Parcelable
| kotlin.Any | |
| ↳ | android.location.GnssAutomaticGainControl |
A class that contains GNSS Automatic Gain Control (AGC) information.
AGC acts as a variable gain amplifier adjusting the power of the incoming signal. The AGC level may be used to indicate potential interference. Higher gain (and/or lower input power) shall be output as a positive number. Hence in cases of strong jamming, in the band of this signal, this value will go more negative. This value must be consistent given the same level of the incoming signal power.
Note: Different hardware designs (e.g. antenna, pre-amplification, or other RF HW components) may also affect the typical output of this value on any given hardware design in an open sky test - the important aspect of this output is that changes in this value are indicative of changes on input signal power in the frequency band for this measurement.
Summary
| Nested classes | |
|---|---|
|
Builder for |
|
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int | |
| Boolean | |
| Long |
Gets the carrier frequency of the tracked signal. |
| Int |
Gets the constellation type. |
| Double |
Gets the Automatic Gain Control level in dB. |
| Int |
hashCode() |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(parcel: Parcel, flag: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<GnssAutomaticGainControl!> | |
Public methods
describeContents
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
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. |
getCarrierFrequencyHz
fun getCarrierFrequencyHz(): Long
Gets the carrier frequency of the tracked signal.
For example it can be the GPS central frequency for L1 = 1575.45 MHz, or L2 = 1227.60 MHz, L5 = 1176.45 MHz, varying GLO channels, etc.
| Return | |
|---|---|
Long |
the carrier frequency of the signal tracked in Hz. Value is 0 or greater |
getConstellationType
fun getConstellationType(): Int
Gets the constellation type.
The return value is one of those constants with CONSTELLATION_ prefix in GnssStatus.
getLevelDb
fun getLevelDb(): Double
Gets the Automatic Gain Control level in dB.
| Return | |
|---|---|
Double |
Value is between -10000 and 10000 inclusive |
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
This value cannot be null. |
writeToParcel
fun writeToParcel(
parcel: Parcel,
flag: 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 |
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. |