GnssCapabilities | API reference

GnssCapabilities | API reference | Android Developers

GNSS chipset capabilities.

Nested classes

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

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<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 `GnssSignalType`s that the GNSS chipset supports.
`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.
`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 requests periodic time signal injection from the platform in addition to on-demand and occasional time updates, `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

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.

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 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
`o`	`Object`: the reference object with which to compare.

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

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`

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

toString

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.