GnssMeasurement

ADR_STATE_CYCLE_SLIP

static val ADR_STATE_CYCLE_SLIP: Int

The state of the getAccumulatedDeltaRangeMeters() has a cycle slip detected.

Value: 4

ADR_STATE_HALF_CYCLE_REPORTED

static val ADR_STATE_HALF_CYCLE_REPORTED: Int

Reports whether the flag ADR_STATE_HALF_CYCLE_RESOLVED has been reported by the GNSS hardware.

When this bit is set, the value of getAccumulatedDeltaRangeUncertaintyMeters() can be low (centimeter level) whether or not the half cycle ambiguity is resolved.

When this bit is unset, the value of getAccumulatedDeltaRangeUncertaintyMeters() is larger, to cover the potential error due to half cycle ambiguity being unresolved.

Value: 16

ADR_STATE_HALF_CYCLE_RESOLVED

static val ADR_STATE_HALF_CYCLE_RESOLVED: Int

Reports whether the value getAccumulatedDeltaRangeMeters() has resolved the half cycle ambiguity.

When this bit is set, the getAccumulatedDeltaRangeMeters() corresponds to the carrier phase measurement plus an accumulated integer number of carrier full cycles.

When this bit is unset, the getAccumulatedDeltaRangeMeters() corresponds to the carrier phase measurement plus an accumulated integer number of carrier half cycles.

For signals that have databits, the carrier phase tracking loops typically use a costas loop discriminator. This type of tracking loop introduces a half-cycle ambiguity that is resolved by searching through the received data for known patterns of databits (e.g. GPS uses the TLM word) which then determines the polarity of the incoming data and resolves the half-cycle ambiguity.

Before the half-cycle ambiguity has been resolved it is possible that the ADR_STATE_VALID flag is set:

• In cases where ADR_STATE_HALF_CYCLE_REPORTED is not set, the ADR_STATE_HALF_CYCLE_RESOLVED flag will not be available. Here, a half wave length will be added to the returned accumulated delta range uncertainty to indicate the half cycle ambiguity.
• In cases where ADR_STATE_HALF_CYCLE_REPORTED is set, half cycle ambiguity will be indicated via both the ADR_STATE_HALF_CYCLE_RESOLVED flag and as well a half wave length added to the returned accumulated delta range uncertainty.

Value: 8

ADR_STATE_RESET

static val ADR_STATE_RESET: Int

The state of the getAccumulatedDeltaRangeMeters() has detected a reset.

Value: 2

ADR_STATE_UNKNOWN

static val ADR_STATE_UNKNOWN: Int

The state of the value getAccumulatedDeltaRangeMeters() is invalid or unknown.

Value: 0

ADR_STATE_VALID

static val ADR_STATE_VALID: Int

The state of the getAccumulatedDeltaRangeMeters() is valid.

Value: 1

MULTIPATH_INDICATOR_DETECTED

static val MULTIPATH_INDICATOR_DETECTED: Int

The measurement shows signs of multi-path.

Value: 1

MULTIPATH_INDICATOR_NOT_DETECTED

static val MULTIPATH_INDICATOR_NOT_DETECTED: Int

The measurement shows no signs of multi-path.

Value: 2

MULTIPATH_INDICATOR_UNKNOWN

static val MULTIPATH_INDICATOR_UNKNOWN: Int

The indicator is not available or the presence or absence of multipath is unknown.

Value: 0

STATE_2ND_CODE_LOCK

static val STATE_2ND_CODE_LOCK: Int

This GNSS measurement's tracking state has secondary code lock.

Value: 65536

STATE_BDS_D2_BIT_SYNC

static val STATE_BDS_D2_BIT_SYNC: Int

This Beidou measurement's tracking state has D2 bit sync.

Value: 256

STATE_BDS_D2_SUBFRAME_SYNC

static val STATE_BDS_D2_SUBFRAME_SYNC: Int

This Beidou measurement's tracking state has D2 sub-frame sync.

Value: 512

STATE_BIT_SYNC

static val STATE_BIT_SYNC: Int

This GNSS measurement's tracking state has bit sync.

Value: 2

STATE_CODE_LOCK

static val STATE_CODE_LOCK: Int

This GNSS measurement's tracking state has code lock.

Value: 1

STATE_GAL_E1BC_CODE_LOCK

static val STATE_GAL_E1BC_CODE_LOCK: Int

This Galileo measurement's tracking state has E1B/C code lock.

Value: 1024

STATE_GAL_E1B_PAGE_SYNC

static val STATE_GAL_E1B_PAGE_SYNC: Int

This Galileo measurement's tracking state has E1B page sync.

Value: 4096

STATE_GAL_E1C_2ND_CODE_LOCK

static val STATE_GAL_E1C_2ND_CODE_LOCK: Int

This Galileo measurement's tracking state has E1C secondary code lock.

Value: 2048

STATE_GLO_STRING_SYNC

static val STATE_GLO_STRING_SYNC: Int

This Glonass measurement's tracking state has string sync.

Value: 64

STATE_GLO_TOD_DECODED

static val STATE_GLO_TOD_DECODED: Int

This Glonass measurement's tracking state has time-of-day decoded.

Value: 128

STATE_GLO_TOD_KNOWN

static val STATE_GLO_TOD_KNOWN: Int

This Glonass measurement's tracking state has time-of-day known, possibly not decoded over the air but has been determined from other sources. If TOD decoded is set then TOD Known will also be set.

Value: 32768

STATE_MSEC_AMBIGUOUS

static val STATE_MSEC_AMBIGUOUS: Int

This GNSS measurement's tracking state contains millisecond ambiguity.

Value: 16

STATE_SBAS_SYNC

static val STATE_SBAS_SYNC: Int

This SBAS measurement's tracking state has whole second level sync.

Value: 8192

STATE_SUBFRAME_SYNC

static val STATE_SUBFRAME_SYNC: Int

This GNSS measurement's tracking state has sub-frame sync.

Value: 4

STATE_SYMBOL_SYNC

static val STATE_SYMBOL_SYNC: Int

This GNSS measurement's tracking state has symbol sync.

Value: 32

STATE_TOW_DECODED

static val STATE_TOW_DECODED: Int

This GNSS measurement's tracking state has time-of-week decoded.

Value: 8

STATE_TOW_KNOWN

static val STATE_TOW_KNOWN: Int

This GNSS measurement's tracking state has time-of-week known, possibly not decoded over the air but has been determined from other sources. If TOW decoded is set then TOW Known will also be set.

Value: 16384

STATE_UNKNOWN

static val STATE_UNKNOWN: Int

This GNSS measurement's tracking state is invalid or unknown.

Value: 0

describeContents

fun describeContents(): Int

getAccumulatedDeltaRangeMeters

fun getAccumulatedDeltaRangeMeters(): Double

Gets the accumulated delta range since the last channel reset, in meters.

The error estimate for this value is getAccumulatedDeltaRangeUncertaintyMeters().

The availability of the value is represented by getAccumulatedDeltaRangeState().

A positive value indicates that the SV is moving away from the receiver. The sign of getAccumulatedDeltaRangeMeters() and its relation to the sign of getCarrierPhase() is given by the equation:

accumulated delta range = -k * carrier phase    (where k is a constant)

Similar to the concept of an RTCM "Phaserange", when the accumulated delta range is initially chosen, and whenever it is reset, it will retain the integer nature of the relative carrier phase offset between satellites observed by this receiver, such that the double difference of this value between receivers and satellites may be used, together with integer ambiguity resolution, to determine highly precise relative location between receivers.

The alignment of the phase measurement will not be adjusted by the receiver so the in-phase and quadrature phase components will have a quarter cycle offset as they do when transmitted from the satellites. If the measurement is from a combination of the in-phase and quadrature phase components, then the alignment of the phase measurement will be aligned to the in-phase component.

getAccumulatedDeltaRangeState

fun getAccumulatedDeltaRangeState(): Int

Gets 'Accumulated Delta Range' state.

This indicates the state of the getAccumulatedDeltaRangeMeters() measurement. See the table below for a detailed interpretation of each state.

getAccumulatedDeltaRangeUncertaintyMeters

fun getAccumulatedDeltaRangeUncertaintyMeters(): Double

Gets the accumulated delta range's uncertainty (1-Sigma) in meters.

The uncertainty is represented as an absolute (single sided) value.

The status of the value is represented by getAccumulatedDeltaRangeState().

getAutomaticGainControlLevelDb

fun getAutomaticGainControlLevelDb(): Double

Deprecated: Use GnssMeasurementsEvent#getGnssAutomaticGainControls() instead.

Gets the Automatic Gain Control level in dB.

AGC acts as a variable gain amplifier adjusting the power of the incoming signal. The AGC level may be used to indicate potential interference. Higher gain (and/or lower input power) shall be output as a positive number. Hence in cases of strong jamming, in the band of this signal, this value will go more negative. This value must be consistent given the same level of the incoming signal power.

Note: Different hardware designs (e.g. antenna, pre-amplification, or other RF HW components) may also affect the typical output of of this value on any given hardware design in an open sky test - the important aspect of this output is that changes in this value are indicative of changes on input signal power in the frequency band for this measurement.

The value is only available if hasAutomaticGainControlLevelDb() is true

getBasebandCn0DbHz

fun getBasebandCn0DbHz(): Double

Gets the baseband carrier-to-noise density in dB-Hz.

Typical range: 10-50 dB-Hz. The range of possible baseband C/N0 values is 0-63 dB-Hz to handle some edge cases.

The value contains the measured C/N0 for the signal at the baseband. This is typically a few dB weaker than the value estimated for C/N0 at the antenna port, which is reported in getCn0DbHz().

getCarrierCycles

fun getCarrierCycles(): Long

Deprecated: use getAccumulatedDeltaRangeMeters() instead.

The number of full carrier cycles between the satellite and the receiver.

The reference frequency is given by the value of getCarrierFrequencyHz().

The value is only available if hasCarrierCycles() is true.

getCarrierFrequencyHz

fun getCarrierFrequencyHz(): Float

Gets the carrier frequency of the tracked signal.

For example it can be the GPS central frequency for L1 = 1575.45 MHz, or L2 = 1227.60 MHz, L5 = 1176.45 MHz, varying GLO channels, etc.

The value is only available if hasCarrierFrequencyHz() is true.

getCarrierPhase

fun getCarrierPhase(): Double

Deprecated: use getAccumulatedDeltaRangeMeters() instead.

Gets the RF phase detected by the receiver.

Range: [0.0, 1.0].

This is the fractional part of the complete carrier phase measurement.

The reference frequency is given by the value of getCarrierFrequencyHz().

The error estimate for this value is getCarrierPhaseUncertainty().

The value is only available if hasCarrierPhase() is true.

getCarrierPhaseUncertainty

fun getCarrierPhaseUncertainty(): Double

Deprecated: use getAccumulatedDeltaRangeUncertaintyMeters() instead.

Gets the carrier-phase's uncertainty (1-Sigma).

The uncertainty is represented as an absolute (single sided) value.

The value is only available if hasCarrierPhaseUncertainty() is true.

getCn0DbHz

fun getCn0DbHz(): Double

Gets the Carrier-to-noise density in dB-Hz.

Typical range: 10-50 dB-Hz. The range of possible C/N0 values is 0-63 dB-Hz to handle some edge cases.

The value contains the measured C/N0 for the signal at the antenna input.

getCodeType

fun getCodeType(): String

Gets the GNSS measurement's code type.

Similar to the Attribute field described in RINEX 4.00, e.g., in Tables 9-16 (see https://igs.org/wg/rinex/#documents-formats).

Returns "A" for GALILEO E1A, GALILEO E6A, NavIC L5A SPS, NavIC SA SPS, GLONASS G1a L1OCd, GLONASS G2a L2CSI.

Returns "B" for GALILEO E1B, GALILEO E6B, NavIC L5B RS (D), NavIC SB RS (D), GLONASS G1a L1OCp, GLONASS G2a L2OCp, QZSS L1Sb.

Returns "C" for GPS L1 C/A, GPS L2 C/A, GLONASS G1 C/A, GLONASS G2 C/A, GALILEO E1C, GALILEO E6C, SBAS L1 C/A, QZSS L1 C/A, NavIC L5C RS (P), NavIC SC RS (P).

Returns "D" for GPS L2 (L1(C/A) + (P2-P1) (semi-codeless)), QZSS L5S(I), BDS B1C Data, BDS B2a Data, BDS B2b Data, BDS B2 (B2a+B2b) Data, BDS B3a Data, NavIC L1 Data.

Returns “E” for QZSS L1 C/B, QZSS L6E.

Returns "I" for GPS L5 I, GLONASS G3 I, GALILEO E5a I, GALILEO E5b I, GALILEO E5a+b I, SBAS L5 I, QZSS L5 I, BDS B1 I, BDS B2 I, BDS B3 I.

Returns "L" for GPS L1C (P), GPS L2C (L), QZSS L1C (P), QZSS L2C (L), QZSS L6P, BDS B1a Pilot.

Returns "M" for GPS L1M, GPS L2M.

Returns "N" for GPS L1 codeless, GPS L2 codeless.

Returns "P" for GPS L1P, GPS L2P, GLONASS G1P, GLONASS G2P, BDS B1C Pilot, BDS B2a Pilot, BDS B2b Pilot, BDS B2 (B2a+B2b) Pilot, BDS B3a Pilot, QZSS L5S(Q), NavIC L1 Pilot.

Returns "Q" for GPS L5 Q, GLONASS G3 Q, GALILEO E5a Q, GALILEO E5b Q, GALILEO E5a+b Q, SBAS L5 Q, QZSS L5 Q, BDS B1 Q, BDS B2 Q, BDS B3 Q.

Returns "S" for GPS L1C (D), GPS L2C (M), QZSS L1C (D), QZSS L2C (M), QZSS L6D, BDS B1a Data.

Returns "W" for GPS L1 Z-tracking, GPS L2 Z-tracking.

Returns "X" for GPS L1C (D+P), GPS L2C (M+L), GPS L5 (I+Q), GLONASS G1a L1OCd+L1OCp, GLONASS G2a L2CSI+L2OCp, GLONASS G3 (I+Q), GALILEO E1 (B+C), GALILEO E5a (I+Q), GALILEO E5b (I+Q), GALILEO E5a+b (I+Q), GALILEO E6 (B+C), SBAS L5 (I+Q), QZSS L1C (D+P), QZSS L2C (M+L), QZSS L5 (I+Q), QZSS L6 (D+P), BDS B1 (I+Q), BDS B1C Data+Pilot, BDS B2a Data+Pilot, BDS B2 (I+Q), BDS B2 (B2a+B2b) Data+Pilot, BDS B3 (I+Q), NavIC L5 (B+C), NavIC S (B+C), NavIC L1 Data+Pilot.

Returns "Y" for GPS L1Y, GPS L2Y.

Returns "Z" for GALILEO E1 (A+B+C), GALILEO E6 (A+B+C), QZSS L1S/L1-SAIF, QZSS L5S (I+Q), QZSS L6(D+E), BDS B1A Data+Pilot, BDS B2b Data+Pilot, BDS B3a Data+Pilot.

Returns "UNKNOWN" if the GNSS Measurement's code type is unknown.

The code type is used to specify the observation descriptor defined in GNSS Observation Data File Header Section Description in the RINEX standard (Version 4.00). In cases where the code type does not align with the above listed values, the code type from the most recent version of RINEX should be used. For example, if a code type "G" is added, this string shall be set to "G".

getConstellationType

fun getConstellationType(): Int

Gets the constellation type.

The return value is one of those constants with CONSTELLATION_ prefix in GnssStatus.

getFullInterSignalBiasNanos

fun getFullInterSignalBiasNanos(): Double

Gets the GNSS measurement's inter-signal bias in nanoseconds with sub-nanosecond accuracy.

This value is the sum of the estimated receiver-side and the space-segment-side inter-system bias, inter-frequency bias and inter-code bias, including:

• Receiver inter-constellation bias (with respect to the constellation in .

getFullInterSignalBiasUncertaintyNanos

fun getFullInterSignalBiasUncertaintyNanos(): Double

Gets the GNSS measurement's inter-signal bias uncertainty (1 sigma) in nanoseconds with sub-nanosecond accuracy.

The value is only available if hasFullInterSignalBiasUncertaintyNanos() is true.

getMultipathIndicator

fun getMultipathIndicator(): Int

Gets a value indicating the 'multipath' state of the event.

getPseudorangeRateMetersPerSecond

fun getPseudorangeRateMetersPerSecond(): Double

Gets the Pseudorange rate at the timestamp in m/s.

The error estimate for this value is getPseudorangeRateUncertaintyMetersPerSecond().

The value is uncorrected, i.e. corrections for receiver and satellite clock frequency errors are not included.

A positive 'uncorrected' value indicates that the SV is moving away from the receiver. The sign of the 'uncorrected' 'pseudorange rate' and its relation to the sign of 'doppler shift' is given by the equation:

pseudorange rate = -k * doppler shift   (where k is a constant)

getPseudorangeRateUncertaintyMetersPerSecond

fun getPseudorangeRateUncertaintyMetersPerSecond(): Double

Gets the pseudorange's rate uncertainty (1-Sigma) in m/s.

The uncertainty is represented as an absolute (single sided) value.

getReceivedSvTimeNanos

fun getReceivedSvTimeNanos(): Long

Gets the received GNSS satellite time, at the measurement time, in nanoseconds.

The received satellite time is relative to the beginning of the system week for all constellations except for Glonass where it is relative to the beginning of the Glonass system day.

The table below indicates the valid range of the received GNSS satellite time. These ranges depend on the constellation and code being tracked and the state of the tracking algorithms given by the getState method. The minimum value of this field is zero. The maximum value of this field is determined by looking across all of the state flags that are set, for the given constellation and code type, and finding the the maximum value in this table.

For example, for GPS L1 C/A, if STATE_TOW_KNOWN is set, this field can be any value from 0 to 1 week (in nanoseconds), and for GAL E1B code, if only STATE_GAL_E1BC_CODE_LOCK is set, then this field can be any value from 0 to 4 milliseconds (in nanoseconds.)

Note: TOW Known refers to the case where TOW is possibly not decoded over the air but has been determined from other sources. If TOW decoded is set then TOW Known must also be set.

Note well: if there is any ambiguity in integer millisecond, STATE_MSEC_AMBIGUOUS must be set accordingly, in the 'state' field. This value must be populated, unless the 'state' == STATE_UNKNOWN.

Note on optional flags:

• For L1 C/A and B1I, STATE_SYMBOL_SYNC is optional since the symbol length is the same as the bit length.
• For L5Q and E5aQ, STATE_BIT_SYNC and STATE_SYMBOL_SYNC are optional since they are implied by STATE_CODE_LOCK.
• STATE_2ND_CODE_LOCK for L5I is optional since it is implied by STATE_SYMBOL_SYNC.
• STATE_2ND_CODE_LOCK for E1C is optional since it is implied by STATE_GAL_E1C_2ND_CODE_LOCK.
• For E1B and E1C, STATE_SYMBOL_SYNC is optional, because it is implied by STATE_GAL_E1BC_CODE_LOCK.

getReceivedSvTimeUncertaintyNanos

fun getReceivedSvTimeUncertaintyNanos(): Long

Gets the error estimate (1-sigma) for the received GNSS time, in nanoseconds.

getSatelliteInterSignalBiasNanos

fun getSatelliteInterSignalBiasNanos(): Double

Gets the GNSS measurement's satellite inter-signal bias in nanoseconds with sub-nanosecond accuracy.

This value is the space-segment-side inter-system bias, inter-frequency bias and inter-code bias, including:

• Master clock bias (e.g., GPS-GAL Time Offset (GGTO), GPS-UTC Time Offset (TauGps), BDS-GLO Time Offset (BGTO))(with respect to the constellation in .

getSatelliteInterSignalBiasUncertaintyNanos

fun getSatelliteInterSignalBiasUncertaintyNanos(): Double

Gets the GNSS measurement's satellite inter-signal bias uncertainty (1 sigma) in nanoseconds with sub-nanosecond accuracy.

The value is only available if hasSatelliteInterSignalBiasUncertaintyNanos() is true.

getSnrInDb

fun getSnrInDb(): Double

Gets the (post-correlation & integration) Signal-to-Noise ratio (SNR) in dB.

The value is only available if hasSnrInDb() is true.

getState

fun getState(): Int

Gets per-satellite-signal sync state.

It represents the current sync state for the associated satellite signal.

This value helps interpret getReceivedSvTimeNanos().

getSvid

fun getSvid(): Int

Gets the satellite ID.

Interpretation depends on getConstellationType(). See GnssStatus#getSvid(int).

getTimeOffsetNanos

fun getTimeOffsetNanos(): Double

Gets the time offset at which the measurement was taken in nanoseconds.

The reference receiver's time from which this is offset is specified by GnssClock#getTimeNanos().

The sign of this value is given by the following equation:

measurement time = TimeNanos + TimeOffsetNanos

The value provides an individual time-stamp for the measurement, and allows sub-nanosecond accuracy.

hasAutomaticGainControlLevelDb

fun hasAutomaticGainControlLevelDb(): Boolean

Deprecated: Use GnssMeasurementsEvent#getGnssAutomaticGainControls() instead.

Returns true if getAutomaticGainControlLevelDb() is available, false otherwise.

hasBasebandCn0DbHz

fun hasBasebandCn0DbHz(): Boolean

Returns true if getBasebandCn0DbHz() is available, false otherwise.

hasCarrierCycles

fun hasCarrierCycles(): Boolean

Deprecated: use getAccumulatedDeltaRangeState() instead.

Returns true if getCarrierCycles() is available, false otherwise.

hasCarrierFrequencyHz

fun hasCarrierFrequencyHz(): Boolean

Returns true if getCarrierFrequencyHz() is available, false otherwise.

hasCarrierPhase

fun hasCarrierPhase(): Boolean

Deprecated: use getAccumulatedDeltaRangeState() instead.

Returns true if getCarrierPhase() is available, false otherwise.

hasCarrierPhaseUncertainty

fun hasCarrierPhaseUncertainty(): Boolean

Deprecated: use getAccumulatedDeltaRangeState() instead.

Returns true if getCarrierPhaseUncertainty() is available, false otherwise.

hasCodeType

fun hasCodeType(): Boolean

Returns true if getCodeType() is available, false otherwise.

hasFullInterSignalBiasNanos

fun hasFullInterSignalBiasNanos(): Boolean

Returns true if getFullInterSignalBiasNanos() is available, false otherwise.

hasFullInterSignalBiasUncertaintyNanos

fun hasFullInterSignalBiasUncertaintyNanos(): Boolean

Returns true if getFullInterSignalBiasUncertaintyNanos() is available, false otherwise.

hasSatelliteInterSignalBiasNanos

fun hasSatelliteInterSignalBiasNanos(): Boolean

Returns true if getSatelliteInterSignalBiasNanos() is available, false otherwise.

hasSatelliteInterSignalBiasUncertaintyNanos

fun hasSatelliteInterSignalBiasUncertaintyNanos(): Boolean

Returns true if getSatelliteInterSignalBiasUncertaintyNanos() is available, false otherwise.

hasSnrInDb

fun hasSnrInDb(): Boolean

Returns true if getSnrInDb() is available, false otherwise.

toString

fun toString(): String

writeToParcel

fun writeToParcel(
    parcel: Parcel, 
    flags: Int
): Unit

CREATOR

static val CREATOR: Parcelable.Creator<GnssMeasurement!>