GnssMeasurementRequest

public final class GnssMeasurementRequest
extends Object implements Parcelable

java.lang.Object
   ↳ android.location.GnssMeasurementRequest


This class contains extra parameters to pass in a GNSS measurement request.

Summary

Nested classes

class GnssMeasurementRequest.Builder

Builder for GnssMeasurementRequest 

Constants

int PASSIVE_INTERVAL

Represents a passive only request.

Inherited constants

Fields

public static final Creator<GnssMeasurementRequest> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

int getIntervalMillis()

Returns the requested time interval between the reported measurements in milliseconds, or PASSIVE_INTERVAL if this is a passive, no power request.

int hashCode()

Returns a hash code value for the object.

boolean isFullTracking()

Represents whether to enable full GNSS tracking.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel parcel, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

PASSIVE_INTERVAL

Added in API level 34
public static final int PASSIVE_INTERVAL

Represents a passive only request. Such a request will not trigger any active GNSS measurements or power usage itself, but may receive GNSS measurements generated in response to other requests.

Note that on Android T, such a request will trigger one GNSS measurement. Another GNSS measurement will be triggered after PASSIVE_INTERVAL and so on.

Constant Value: 2147483647 (0x7fffffff)

Fields

CREATOR

Added in API level 31
public static final Creator<GnssMeasurementRequest> CREATOR

Public methods

describeContents

Added in API level 31
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

equals

Added in API level 31
public boolean equals (Object obj)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getIntervalMillis

Added in API level 33
public int getIntervalMillis ()

Returns the requested time interval between the reported measurements in milliseconds, or PASSIVE_INTERVAL if this is a passive, no power request. A passive request will not actively generate GNSS measurement updates, but may receive GNSS measurement updates generated as a result of other GNSS measurement requests.

If the time interval is not set, the default value is 0, which means the fastest rate the GNSS chipset can report.

The GNSS chipset may report measurements with a rate faster than requested.

Note that on Android T, a request interval of PASSIVE_INTERVAL will first trigger one GNSS measurement. Another GNSS measurement will be triggered after PASSIVE_INTERVAL milliseconds ans so on.

Returns
int Value is 0 or greater

hashCode

Added in API level 31
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int a hash code value for this object.

isFullTracking

Added in API level 31
public boolean isFullTracking ()

Represents whether to enable full GNSS tracking.

If true, GNSS chipset switches off duty cycling. In such a 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. The GNSS chipset will consume more power in full tracking mode than in duty cycling mode. If false, GNSS chipset optimizes power via duty cycling, constellations and frequency limits, etc.

Full GNSS tracking mode affects GnssMeasurement and other GNSS functionalities including GNSS location.

Returns
boolean

toString

Added in API level 31
public String toString ()

Returns a string representation of the object.

Returns
String This value cannot be null.

writeToParcel

Added in API level 31
public void writeToParcel (Parcel parcel, 
                int flags)

Flatten this object in to a Parcel.

Parameters
parcel Parcel: 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