Added in API level 24

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

GnssMeasurementsEvent

Kotlin |Java

public final class GnssMeasurementsEvent
extends Object implements Parcelable

java.lang.Object
↳	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
`class`	`GnssMeasurementsEvent.Builder` Builder for `GnssMeasurementsEvent`
`class`	`GnssMeasurementsEvent.Callback` Used for receiving GNSS satellite measurements from the GNSS engine.

Inherited constants

From interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<GnssMeasurementsEvent>`	`CREATOR`

Public methods
`int`	`describeContents()` 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.
`Collection<GnssAutomaticGainControl>`	`getGnssAutomaticGainControls()` Gets the collection of `GnssAutomaticGainControl` associated with the current event.
`Collection<GnssMeasurement>`	`getMeasurements()` Gets the collection of measurements associated with the current event.
`boolean`	`hasIsFullTracking()` Return `true` if `isFullTracking()` is available, `false` otherwise.
`boolean`	`isFullTracking()` 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.
`void`	`writeToParcel(Parcel parcel, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 24

public static final Creator<GnssMeasurementsEvent> CREATOR

Public methods

describeContents

Added in API level 24

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`

getClock

Added in API level 24

public GnssClock getClock ()

Gets the GNSS receiver clock information associated with the measurements for the current event.

Returns
`GnssClock`	This value cannot be `null`.

getGnssAutomaticGainControls

Added in API level 33

public Collection<GnssAutomaticGainControl> getGnssAutomaticGainControls ()

Gets the collection of GnssAutomaticGainControl associated with the current event.

Returns
`Collection<GnssAutomaticGainControl>`	This value cannot be `null`.

getMeasurements

Added in API level 24

public Collection<GnssMeasurement> getMeasurements ()

Gets the collection of measurements associated with the current event.

Returns
`Collection<GnssMeasurement>`	This value cannot be `null`.

hasIsFullTracking

Added in API level 34

public boolean hasIsFullTracking ()

Return true if isFullTracking() is available, false otherwise.

Returns
`boolean`

isFullTracking

Added in API level 34

public boolean isFullTracking ()

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.

Returns
`boolean`

toString

Added in API level 24

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 24

public void writeToParcel (Parcel parcel, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`parcel`	`Parcel`: 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.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

GnssMeasurementsEvent

Summary

Nested classes

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

describeContents

getClock

getGnssAutomaticGainControls

getMeasurements

hasIsFullTracking

isFullTracking

toString

writeToParcel