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

GnssCapabilities

public final class GnssCapabilities
extends Object implements Parcelable

java.lang.Object
   ↳ android.location.GnssCapabilities


GNSS chipset capabilities.

Summary

Nested classes

class GnssCapabilities.Builder

Builder for GnssCapabilities. 

Inherited constants

Fields

public static final Creator<GnssCapabilities> CREATOR

Public methods

int describeContents()

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

boolean equals(Object o)

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

List<GnssSignalType> getGnssSignalTypes()

Returns the list of GnssSignalTypes that the GNSS chipset supports.

boolean hasAccumulatedDeltaRange()

Returns true if GNSS chipset supports accumulated delta range, false otherwise.

boolean hasAntennaInfo()

Returns true if GNSS chipset supports antenna info, false otherwise.

boolean hasGeofencing()

Returns true if GNSS chipset supports geofencing, false otherwise.

boolean hasGnssAntennaInfo()

This method was deprecated in API level 31. Use hasAntennaInfo() instead.

boolean hasLowPowerMode()

Returns true if GNSS chipset supports low power mode, false otherwise.

boolean hasMeasurementCorrections()

Returns true if GNSS chipset supports measurement corrections, false otherwise.

boolean hasMeasurementCorrectionsExcessPathLength()

Returns true if GNSS chipset supports per satellite excess-path-length measurement corrections, false otherwise.

boolean hasMeasurementCorrectionsForDriving()

Returns true if GNSS chipset will benefit from measurement corrections for driving use case if provided, false otherwise.

boolean hasMeasurementCorrectionsLosSats()

Returns true if GNSS chipset supports line-of-sight satellite identification measurement corrections, false otherwise.

boolean hasMeasurementCorrectionsReflectingPlane()

Returns true if GNSS chipset supports reflecting plane measurement corrections, false otherwise.

boolean hasMeasurementCorrelationVectors()

Returns true if GNSS chipset supports correlation vectors as part of measurements outputs, false otherwise.

boolean hasMeasurements()

Returns true if GNSS chipset supports measurements, false otherwise.

boolean hasMsa()

Returns true if GNSS chipset supports Mobile Station Assisted assitance, false otherwise.

boolean hasMsb()

Returns true if GNSS chipset supports Mobile Station Based assistance, false otherwise.

boolean hasNavigationMessages()

Returns true if GNSS chipset supports navigation messages, false otherwise.

boolean hasOnDemandTime()

Returns true if GNSS chipset supports on demand time, false otherwise.

boolean hasPowerMultibandAcquisition()

Returns true if GNSS chipset supports measuring multi-band acquisition power, false otherwise.

boolean hasPowerMultibandTracking()

Returns true if GNSS chipset supports measuring multi-band tracking power, false otherwise.

boolean hasPowerOtherModes()

Returns true if GNSS chipset supports measuring OEM defined mode power, false otherwise.

boolean hasPowerSinglebandAcquisition()

Returns true if GNSS chipset supports measuring single-band acquisition power, false otherwise.

boolean hasPowerSinglebandTracking()

Returns true if GNSS chipset supports measuring single-band tracking power, false otherwise.

boolean hasPowerTotal()

Returns true if GNSS chipset supports measuring power totals, false otherwise.

boolean hasSatelliteBlocklist()

Returns true if GNSS chipset supports satellite blocklists, false otherwise.

boolean hasSatellitePvt()

Returns true if GNSS chipset supports satellite PVT, false otherwise.

boolean hasScheduling()

Returns true if GNSS chipset supports scheduling, false otherwise.

boolean hasSingleShotFix()

Returns true if GNSS chipset supports single shot locating, false otherwise.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel parcel, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 31
public static final Creator<GnssCapabilities> 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 30
public boolean equals (Object o)

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

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

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

getGnssSignalTypes

public List<GnssSignalType> getGnssSignalTypes ()

Returns the list of GnssSignalTypes that the GNSS chipset supports.

Returns
List<GnssSignalType> This value cannot be null.

hasAccumulatedDeltaRange

public boolean hasAccumulatedDeltaRange ()

Returns true if GNSS chipset supports accumulated delta range, false otherwise.

The accumulated delta range information can be queried in GnssMeasurement.getAccumulatedDeltaRangeState(), GnssMeasurement.getAccumulatedDeltaRangeMeters(), and GnssMeasurement.getAccumulatedDeltaRangeUncertaintyMeters().

Returns
boolean

hasAntennaInfo

Added in API level 31
public boolean hasAntennaInfo ()

Returns true if GNSS chipset supports antenna info, false otherwise.

Returns
boolean

hasGeofencing

public boolean hasGeofencing ()

Returns true if GNSS chipset supports geofencing, false otherwise.

Returns
boolean

hasGnssAntennaInfo

Added in API level 30
Deprecated in API level 31
public boolean hasGnssAntennaInfo ()

This method was deprecated in API level 31.
Use hasAntennaInfo() instead.

Returns true if GNSS chipset supports antenna info, false otherwise.

Returns
boolean

hasLowPowerMode

public boolean hasLowPowerMode ()

Returns true if GNSS chipset supports low power mode, false otherwise.

The low power mode is defined in GNSS HAL. When the low power mode is active, the GNSS hardware must make strong tradeoffs to substantially restrict power use.

Returns
boolean

hasMeasurementCorrections

public boolean hasMeasurementCorrections ()

Returns true if GNSS chipset supports measurement corrections, false otherwise.

Returns
boolean

hasMeasurementCorrectionsExcessPathLength

public boolean hasMeasurementCorrectionsExcessPathLength ()

Returns true if GNSS chipset supports per satellite excess-path-length measurement corrections, false otherwise.

Returns
boolean

hasMeasurementCorrectionsForDriving

public boolean hasMeasurementCorrectionsForDriving ()

Returns true if GNSS chipset will benefit from measurement corrections for driving use case if provided, false otherwise.

Returns
boolean

hasMeasurementCorrectionsLosSats

public boolean hasMeasurementCorrectionsLosSats ()

Returns true if GNSS chipset supports line-of-sight satellite identification measurement corrections, false otherwise.

Returns
boolean

hasMeasurementCorrectionsReflectingPlane

public boolean hasMeasurementCorrectionsReflectingPlane ()

Returns true if GNSS chipset supports reflecting plane measurement corrections, false otherwise.

Returns
boolean

hasMeasurementCorrelationVectors

public boolean hasMeasurementCorrelationVectors ()

Returns true if GNSS chipset supports correlation vectors as part of measurements outputs, false otherwise.

Returns
boolean

hasMeasurements

Added in API level 31
public boolean hasMeasurements ()

Returns true if GNSS chipset supports measurements, false otherwise.

Returns
boolean

hasMsa

public boolean hasMsa ()

Returns true if GNSS chipset supports Mobile Station Assisted assitance, false otherwise.

Returns
boolean

hasMsb

public boolean hasMsb ()

Returns true if GNSS chipset supports Mobile Station Based assistance, false otherwise.

Returns
boolean

hasNavigationMessages

Added in API level 31
public boolean hasNavigationMessages ()

Returns true if GNSS chipset supports navigation messages, false otherwise.

Returns
boolean

hasOnDemandTime

public boolean hasOnDemandTime ()

Returns true if GNSS chipset supports on demand time, false otherwise.

Returns
boolean

hasPowerMultibandAcquisition

public boolean hasPowerMultibandAcquisition ()

Returns true if GNSS chipset supports measuring multi-band acquisition power, false otherwise.

Returns
boolean

hasPowerMultibandTracking

public boolean hasPowerMultibandTracking ()

Returns true if GNSS chipset supports measuring multi-band tracking power, false otherwise.

Returns
boolean

hasPowerOtherModes

public boolean hasPowerOtherModes ()

Returns true if GNSS chipset supports measuring OEM defined mode power, false otherwise.

Returns
boolean

hasPowerSinglebandAcquisition

public boolean hasPowerSinglebandAcquisition ()

Returns true if GNSS chipset supports measuring single-band acquisition power, false otherwise.

Returns
boolean

hasPowerSinglebandTracking

public boolean hasPowerSinglebandTracking ()

Returns true if GNSS chipset supports measuring single-band tracking power, false otherwise.

Returns
boolean

hasPowerTotal

public boolean hasPowerTotal ()

Returns true if GNSS chipset supports measuring power totals, false otherwise.

Returns
boolean

hasSatelliteBlocklist

public boolean hasSatelliteBlocklist ()

Returns true if GNSS chipset supports satellite blocklists, false otherwise.

Returns
boolean

hasSatellitePvt

public boolean hasSatellitePvt ()

Returns true if GNSS chipset supports satellite PVT, false otherwise.

Returns
boolean

hasScheduling

public boolean hasScheduling ()

Returns true if GNSS chipset supports scheduling, false otherwise.

Returns
boolean

hasSingleShotFix

public boolean hasSingleShotFix ()

Returns true if GNSS chipset supports single shot locating, false otherwise.

Returns
boolean

hashCode

Added in API level 30
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(Object) 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(java.lang.Object) 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)

Returns
int a hash code value for this object.

toString

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