GnssStatus.Builder

Kotlin |Java

public static final class GnssStatus.Builder
extends Object

java.lang.Object
↳	android.location.GnssStatus.Builder

Builder class to help create new GnssStatus instances.

Summary

Public constructors
`Builder()`

Public methods
`GnssStatus.Builder`	`addSatellite(int constellationType, int svid, float cn0DbHz, float elevation, float azimuth, boolean hasEphemeris, boolean hasAlmanac, boolean usedInFix, boolean hasCarrierFrequency, float carrierFrequency, boolean hasBasebandCn0DbHz, float basebandCn0DbHz, boolean hasCodeType, String codeType, boolean hasElapsedRealtimeNanos, long elapsedRealtimeNanos, boolean hasElapsedRealtimeUncertaintyNanos, double elapsedRealtimeUncertaintyNanos)` Adds a new satellite to the Builder.
`GnssStatus.Builder`	`addSatellite(int constellationType, int svid, float cn0DbHz, float elevation, float azimuth, boolean hasEphemeris, boolean hasAlmanac, boolean usedInFix, boolean hasCarrierFrequency, float carrierFrequency, boolean hasBasebandCn0DbHz, float basebandCn0DbHz)` Adds a new satellite to the Builder.
`GnssStatus`	`build()` Builds a new GnssStatus based on the satellite information in the Builder.
`GnssStatus.Builder`	`clearSatellites()` Clears all satellites in the Builder.

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.

Public constructors

Builder

Added in API level 30

public Builder ()

Public methods

addSatellite

Added in API level 30

public GnssStatus.Builder addSatellite (int constellationType, 
                int svid, 
                float cn0DbHz, 
                float elevation, 
                float azimuth, 
                boolean hasEphemeris, 
                boolean hasAlmanac, 
                boolean usedInFix, 
                boolean hasCarrierFrequency, 
                float carrierFrequency, 
                boolean hasBasebandCn0DbHz, 
                float basebandCn0DbHz, 
                boolean hasCodeType, 
                String codeType, 
                boolean hasElapsedRealtimeNanos, 
                long elapsedRealtimeNanos, 
                boolean hasElapsedRealtimeUncertaintyNanos, 
                double elapsedRealtimeUncertaintyNanos)

Adds a new satellite to the Builder.

Parameters
`constellationType`	`int`: one of the CONSTELLATION_* constants. Value is one of the following: `GnssStatus.CONSTELLATION_UNKNOWN` `GnssStatus.CONSTELLATION_GPS` `GnssStatus.CONSTELLATION_SBAS` `GnssStatus.CONSTELLATION_GLONASS` `GnssStatus.CONSTELLATION_QZSS` `GnssStatus.CONSTELLATION_BEIDOU` `GnssStatus.CONSTELLATION_GALILEO` `GnssStatus.CONSTELLATION_IRNSS`
`svid`	`int`: the space vehicle identifier. Value is between 1 and 200 inclusive
`cn0DbHz`	`float`: carrier-to-noise density at the antenna in dB-Hz. Value is between 0.0f and 63.0f inclusive
`elevation`	`float`: satellite elevation in degrees. Value is between -90.0f and 90.0f inclusive
`azimuth`	`float`: satellite azimuth in degrees. Value is between 0.0f and 360.0f inclusive
`hasEphemeris`	`boolean`: whether the satellite has ephemeris data
`hasAlmanac`	`boolean`: whether the satellite has almanac data
`usedInFix`	`boolean`: whether the satellite was used in the most recent location fix
`hasCarrierFrequency`	`boolean`: whether carrier frequency data is available
`carrierFrequency`	`float`: satellite carrier frequency in Hz. Value is 0.0f or greater
`hasBasebandCn0DbHz`	`boolean`: whether baseband carrier-to-noise density is available
`basebandCn0DbHz`	`float`: baseband carrier-to-noise density in dB-Hz. Value is between 0.0f and 63.0f inclusive
`hasCodeType`	`boolean`: whether codetype is available
`codeType`	`String`: the code type as defined in `GnssMeasurement.getCodeType()` This value cannot be `null`. Value is one of the following: `GnssMeasurement.CODE_TYPE_A` `GnssMeasurement.CODE_TYPE_B` `GnssMeasurement.CODE_TYPE_C` `GnssMeasurement.CODE_TYPE_D` `GnssMeasurement.CODE_TYPE_E` `GnssMeasurement.CODE_TYPE_I` `GnssMeasurement.CODE_TYPE_L` `GnssMeasurement.CODE_TYPE_M` `GnssMeasurement.CODE_TYPE_N` `GnssMeasurement.CODE_TYPE_P` `GnssMeasurement.CODE_TYPE_Q` `GnssMeasurement.CODE_TYPE_S` `GnssMeasurement.CODE_TYPE_W` `GnssMeasurement.CODE_TYPE_X` `GnssMeasurement.CODE_TYPE_Y` `GnssMeasurement.CODE_TYPE_Z` `GnssMeasurement.CODE_TYPE_UNKNOWN`
`hasElapsedRealtimeNanos`	`boolean`: whether the elapsedRealtimeNanos is available
`elapsedRealtimeNanos`	`long`: the elapsed real-time of this GnssStatus since system boot, in nanoseconds. Value is 0 or greater
`hasElapsedRealtimeUncertaintyNanos`	`boolean`: whether the elapsedRealTimeUncertanityNanos is available
`elapsedRealtimeUncertaintyNanos`	`double`: estimate of the relative precision of the alignment of this GnssStatus timestamp, with the reported measurements in nanoseconds (68% confidence). Value is 0.0f or greater

Returns
`GnssStatus.Builder`	This value cannot be `null`.

addSatellite

Added in API level 30

public GnssStatus.Builder addSatellite (int constellationType, 
                int svid, 
                float cn0DbHz, 
                float elevation, 
                float azimuth, 
                boolean hasEphemeris, 
                boolean hasAlmanac, 
                boolean usedInFix, 
                boolean hasCarrierFrequency, 
                float carrierFrequency, 
                boolean hasBasebandCn0DbHz, 
                float basebandCn0DbHz)

Adds a new satellite to the Builder.

Parameters
`constellationType`	`int`: one of the CONSTELLATION_* constants. Value is one of the following: `GnssStatus.CONSTELLATION_UNKNOWN` `GnssStatus.CONSTELLATION_GPS` `GnssStatus.CONSTELLATION_SBAS` `GnssStatus.CONSTELLATION_GLONASS` `GnssStatus.CONSTELLATION_QZSS` `GnssStatus.CONSTELLATION_BEIDOU` `GnssStatus.CONSTELLATION_GALILEO` `GnssStatus.CONSTELLATION_IRNSS`
`svid`	`int`: the space vehicle identifier. Value is between 1 and 200 inclusive
`cn0DbHz`	`float`: carrier-to-noise density at the antenna in dB-Hz. Value is between 0.0f and 63.0f inclusive
`elevation`	`float`: satellite elevation in degrees. Value is between -90.0f and 90.0f inclusive
`azimuth`	`float`: satellite azimuth in degrees. Value is between 0.0f and 360.0f inclusive
`hasEphemeris`	`boolean`: whether the satellite has ephemeris data
`hasAlmanac`	`boolean`: whether the satellite has almanac data
`usedInFix`	`boolean`: whether the satellite was used in the most recent location fix
`hasCarrierFrequency`	`boolean`: whether carrier frequency data is available
`carrierFrequency`	`float`: satellite carrier frequency in Hz. Value is 0.0f or greater
`hasBasebandCn0DbHz`	`boolean`: whether baseband carrier-to-noise density is available
`basebandCn0DbHz`	`float`: baseband carrier-to-noise density in dB-Hz. Value is between 0.0f and 63.0f inclusive

Returns
`GnssStatus.Builder`	This value cannot be `null`.

build

Added in API level 30

public GnssStatus build ()

Builds a new GnssStatus based on the satellite information in the Builder.

Returns
`GnssStatus`	This value cannot be `null`.

clearSatellites

Added in API level 30

public GnssStatus.Builder clearSatellites ()

Clears all satellites in the Builder.

Returns
`GnssStatus.Builder`	This value cannot be `null`.