Stay organized with collections Save and categorize content based on your preferences.

public final class GnssMeasurementsEvent
extends Object implements Parcelable


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 hasFullTracking()

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.

hasFullTracking

public boolean hasFullTracking ()

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

Returns
boolean

isFullTracking

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 hasFullTracking() is true.

Returns
boolean

toString

Added in API level 24 

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 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

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2023-02-08 UTC.