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. |
Constants | |
|---|---|
int |
CAPABILITY_SUPPORTED
The capability is supported. |
int |
CAPABILITY_UNKNOWN
The capability is unknown to be supported or not. |
int |
CAPABILITY_UNSUPPORTED
The capability is not supported. |
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 |
int
|
hasAccumulatedDeltaRange()
Returns |
boolean
|
hasAntennaInfo()
Returns |
boolean
|
hasGeofencing()
Returns |
boolean
|
hasGnssAntennaInfo()
This method was deprecated
in API level 31.
Use |
boolean
|
hasLowPowerMode()
Returns |
boolean
|
hasMeasurementCorrections()
Returns |
boolean
|
hasMeasurementCorrectionsExcessPathLength()
Returns |
boolean
|
hasMeasurementCorrectionsForDriving()
Returns |
boolean
|
hasMeasurementCorrectionsLosSats()
Returns |
boolean
|
hasMeasurementCorrectionsReflectingPlane()
Returns |
boolean
|
hasMeasurementCorrelationVectors()
Returns |
boolean
|
hasMeasurements()
Returns |
boolean
|
hasMsa()
Returns |
boolean
|
hasMsb()
Returns |
boolean
|
hasNavigationMessages()
Returns |
boolean
|
hasOnDemandTime()
Returns |
boolean
|
hasPowerMultibandAcquisition()
Returns |
boolean
|
hasPowerMultibandTracking()
Returns |
boolean
|
hasPowerOtherModes()
Returns |
boolean
|
hasPowerSinglebandAcquisition()
Returns |
boolean
|
hasPowerSinglebandTracking()
Returns |
boolean
|
hasPowerTotal()
Returns |
boolean
|
hasSatelliteBlocklist()
Returns |
boolean
|
hasSatellitePvt()
Returns |
boolean
|
hasScheduling()
Returns |
boolean
|
hasSingleShotFix()
Returns |
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 | |
|---|---|
Constants
CAPABILITY_SUPPORTED
public static final int CAPABILITY_SUPPORTED
The capability is supported.
Constant Value: 1 (0x00000001)
CAPABILITY_UNKNOWN
public static final int CAPABILITY_UNKNOWN
The capability is unknown to be supported or not.
Constant Value: 0 (0x00000000)
CAPABILITY_UNSUPPORTED
public static final int CAPABILITY_UNSUPPORTED
The capability is not supported.
Constant Value: 2 (0x00000002)
Fields
Public methods
describeContents
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
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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 | |
|---|---|
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 int hasAccumulatedDeltaRange ()
Returns CAPABILITY_SUPPORTED if GNSS chipset supports accumulated delta
range, CAPABILITY_UNSUPPORTED if GNSS chipset does not support accumulated
delta range, and CAPABILITY_UNKNOWN if it is unknown, which means GNSS
chipset may or may not support accumulated delta range.
The accumulated delta range information can be queried in
GnssMeasurement.getAccumulatedDeltaRangeState(),
GnssMeasurement.getAccumulatedDeltaRangeMeters(), and
GnssMeasurement.getAccumulatedDeltaRangeUncertaintyMeters().
| Returns | |
|---|---|
int |
Value is either 0 or a combination of CAPABILITY_UNKNOWN, CAPABILITY_SUPPORTED, and CAPABILITY_UNSUPPORTED |
hasAntennaInfo
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
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
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
public boolean hasNavigationMessages ()
Returns true if GNSS chipset supports navigation messages, false otherwise.
| Returns | |
|---|---|
boolean |
|
hasOnDemandTime
public boolean hasOnDemandTime ()
Returns true if GNSS chipset requests periodic time signal injection from the
platform in addition to on-demand and occasional time updates, false otherwise.
Note: The naming of this capability and the behavior it controls differ substantially. This is the result of a historic implementation bug, b/73893222.
| 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
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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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. |
toString
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
String |
a string representation of the object. |
writeToParcel
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 |
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 2025-02-10 UTC.