Added in API level 30

GnssCapabilities


class GnssCapabilities : Parcelable
kotlin.Any
   ↳ android.location.GnssCapabilities

GNSS chipset capabilities.

Summary

Nested classes

Builder for GnssCapabilities.

Constants
static Int

The capability is supported.

static Int

The capability is unknown to be supported or not.

static Int

The capability is not supported.

Inherited constants
Public methods
Int

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

Boolean
equals(other: Any?)

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

MutableList<GnssSignalType!>

Returns the list of GnssSignalTypes that the GNSS chipset supports.

Int

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.

Boolean

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

Boolean

Returns true if GNSS chipset supports geofencing, false otherwise.

Boolean

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

Boolean

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

Boolean

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

Boolean

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

Boolean

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

Boolean

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

Boolean

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

Boolean

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

Boolean

Returns true if GNSS chipset supports measurements, false otherwise.

Boolean

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

Boolean

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

Boolean

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

Boolean

Returns true if GNSS chipset requests periodic time signal injection from the platform in addition to on-demand and occasional time updates, false otherwise.

Boolean

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

Boolean

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

Boolean

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

Boolean

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

Boolean

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

Boolean

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

Boolean

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

Boolean

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

Boolean

Returns true if GNSS chipset supports scheduling, false otherwise.

Boolean

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

Int

Returns a hash code value for the object.

String

Returns a string representation of the object.

Unit
writeToParcel(parcel: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<GnssCapabilities!>

Constants

CAPABILITY_SUPPORTED

Added in API level 34
static val CAPABILITY_SUPPORTED: Int

The capability is supported.

Value: 1

CAPABILITY_UNKNOWN

Added in API level 34
static val CAPABILITY_UNKNOWN: Int

The capability is unknown to be supported or not.

Value: 0

CAPABILITY_UNSUPPORTED

Added in API level 34
static val CAPABILITY_UNSUPPORTED: Int

The capability is not supported.

Value: 2

Public methods

describeContents

Added in API level 31
fun describeContents(): Int

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.

Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
Value is either 0 or

equals

Added in API level 30
fun equals(other: Any?): Boolean

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 the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getGnssSignalTypes

Added in API level 34
fun getGnssSignalTypes(): MutableList<GnssSignalType!>

Returns the list of GnssSignalTypes that the GNSS chipset supports.

Return
MutableList<GnssSignalType!> This value cannot be null.

hasAccumulatedDeltaRange

Added in API level 34
fun hasAccumulatedDeltaRange(): Int

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 android.location.GnssMeasurement#getAccumulatedDeltaRangeState(), android.location.GnssMeasurement#getAccumulatedDeltaRangeMeters(), and android.location.GnssMeasurement#getAccumulatedDeltaRangeUncertaintyMeters().

Return
Int Value is either 0 or a combination of the following:

hasAntennaInfo

Added in API level 31
fun hasAntennaInfo(): Boolean

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

hasGeofencing

Added in API level 34
fun hasGeofencing(): Boolean

Returns true if GNSS chipset supports geofencing, false otherwise.

hasGnssAntennaInfo

Added in API level 30
Deprecated in API level 31
fun hasGnssAntennaInfo(): Boolean

Deprecated: Use hasAntennaInfo() instead.

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

hasLowPowerMode

Added in API level 34
fun hasLowPowerMode(): Boolean

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.

hasMeasurementCorrections

Added in API level 34
fun hasMeasurementCorrections(): Boolean

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

hasMeasurementCorrectionsExcessPathLength

Added in API level 34
fun hasMeasurementCorrectionsExcessPathLength(): Boolean

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

hasMeasurementCorrectionsForDriving

Added in API level 34
fun hasMeasurementCorrectionsForDriving(): Boolean

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

hasMeasurementCorrectionsLosSats

Added in API level 34
fun hasMeasurementCorrectionsLosSats(): Boolean

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

hasMeasurementCorrectionsReflectingPlane

Added in API level 34
fun hasMeasurementCorrectionsReflectingPlane(): Boolean

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

hasMeasurementCorrelationVectors

Added in API level 34
fun hasMeasurementCorrelationVectors(): Boolean

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

hasMeasurements

Added in API level 31
fun hasMeasurements(): Boolean

Returns true if GNSS chipset supports measurements, false otherwise.

hasMsa

Added in API level 34
fun hasMsa(): Boolean

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

hasMsb

Added in API level 34
fun hasMsb(): Boolean

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

hasNavigationMessages

Added in API level 31
fun hasNavigationMessages(): Boolean

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

hasOnDemandTime

Added in API level 34
fun hasOnDemandTime(): Boolean

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.

hasPowerMultibandAcquisition

Added in API level 34
fun hasPowerMultibandAcquisition(): Boolean

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

hasPowerMultibandTracking

Added in API level 34
fun hasPowerMultibandTracking(): Boolean

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

hasPowerOtherModes

Added in API level 34
fun hasPowerOtherModes(): Boolean

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

hasPowerSinglebandAcquisition

Added in API level 34
fun hasPowerSinglebandAcquisition(): Boolean

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

hasPowerSinglebandTracking

Added in API level 34
fun hasPowerSinglebandTracking(): Boolean

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

hasPowerTotal

Added in API level 34
fun hasPowerTotal(): Boolean

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

hasSatelliteBlocklist

Added in API level 34
fun hasSatelliteBlocklist(): Boolean

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

hasSatellitePvt

Added in API level 34
fun hasSatellitePvt(): Boolean

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

hasScheduling

Added in API level 34
fun hasScheduling(): Boolean

Returns true if GNSS chipset supports scheduling, false otherwise.

hasSingleShotFix

Added in API level 34
fun hasSingleShotFix(): Boolean

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

hashCode

Added in API level 30
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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.
Return
Int a hash code value for this object.

toString

Added in API level 30
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

writeToParcel

Added in API level 31
fun writeToParcel(
    parcel: Parcel,
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest 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_WRITE_RETURN_VALUE.
Value is either 0 or a combination of the following:
parcel Parcel: This value cannot be null.

Properties

CREATOR

Added in API level 31
static val CREATOR: Parcelable.Creator<GnssCapabilities!>