GnssMeasurementsEvent
class GnssMeasurementsEvent : Parcelable
| kotlin.Any | |
| ↳ | android.location.GnssMeasurementsEvent |
A class implementing a container for data associated with a measurement event. Events are delivered to registered instances of Callback.
Summary
| Nested classes | |
|---|---|
|
Builder for |
|
| abstract |
Used for receiving GNSS satellite measurements from the GNSS engine. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| GnssClock |
getClock()Gets the GNSS receiver clock information associated with the measurements for the current event. |
| MutableCollection<GnssAutomaticGainControl!> |
Gets the collection of |
| MutableCollection<GnssMeasurement!> |
Gets the collection of measurements associated with the current event. |
| Boolean |
Return |
| Boolean |
True indicates that this event was produced while the chipset was in full tracking mode, ie, the GNSS chipset switched off duty cycling. |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(parcel: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<GnssMeasurementsEvent!> | |
Public methods
describeContents
fun describeContents(): Int
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.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
getClock
fun getClock(): GnssClock
Gets the GNSS receiver clock information associated with the measurements for the current event.
| Return | |
|---|---|
GnssClock |
This value cannot be null. |
getGnssAutomaticGainControls
fun getGnssAutomaticGainControls(): MutableCollection<GnssAutomaticGainControl!>
Gets the collection of GnssAutomaticGainControl associated with the current event.
This field must be reported when the GNSS measurement engine is running, even when the GnssMeasurement or GnssClock fields are not reported yet. E.g., when a GNSS signal is too weak to be acquired, the AGC value must still be reported.
For devices that do not support this field, an empty collection is returned. In that case, please use GnssMeasurement.hasAutomaticGainControlLevelDb() and GnssMeasuremen#getAutomaticGainControlLevelDb().
| Return | |
|---|---|
MutableCollection<GnssAutomaticGainControl!> |
This value cannot be null. |
getMeasurements
fun getMeasurements(): MutableCollection<GnssMeasurement!>
Gets the collection of measurements associated with the current event.
| Return | |
|---|---|
MutableCollection<GnssMeasurement!> |
This value cannot be null. |
hasIsFullTracking
fun hasIsFullTracking(): Boolean
Return true if isFullTracking() is available, false otherwise.
isFullTracking
fun isFullTracking(): Boolean
True indicates that this event was produced while the chipset was in full tracking mode, ie, the GNSS chipset switched off duty cycling. In this mode, no clock discontinuities are expected and, when supported, carrier phase should be continuous in good signal conditions. All non-blocklisted, healthy constellations, satellites and frequency bands that are meaningful to positioning accuracy must be tracked and reported in this mode. False indicates that the GNSS chipset may optimize power via duty cycling, constellations and frequency limits, etc.
The value is only available if hasIsFullTracking() is true.
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
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 the following:
|