GnssClock

CREATOR

public static final Creator<GnssClock> CREATOR

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.

getBiasNanos

public double getBiasNanos ()

Gets the clock's sub-nanosecond bias.

See the description of how this field is part of converting from hardware clock time, to GPS time, in getFullBiasNanos().

The error estimate for the sum of this field and getFullBiasNanos() is getBiasUncertaintyNanos().

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

getBiasUncertaintyNanos

public double getBiasUncertaintyNanos ()

Gets the clock's Bias Uncertainty (1-Sigma) in nanoseconds.

See the description of how this field provides the error estimate in the conversion from hardware clock time, to GPS time, in getFullBiasNanos().

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

getDriftNanosPerSecond

public double getDriftNanosPerSecond ()

Gets the clock's Drift in nanoseconds per second.

This value is the instantaneous time-derivative of the value provided by the sum of getFullBiasNanos() and getBiasNanos().

A positive value indicates that the frequency is higher than the nominal (e.g. GPS master clock) frequency. The error estimate for this reported drift is getDriftUncertaintyNanosPerSecond().

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

getDriftUncertaintyNanosPerSecond

public double getDriftUncertaintyNanosPerSecond ()

Gets the clock's Drift Uncertainty (1-Sigma) in nanoseconds per second.

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

getElapsedRealtimeNanos

public long getElapsedRealtimeNanos ()

Returns the elapsed real-time of this clock since system boot, in nanoseconds.

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

getElapsedRealtimeUncertaintyNanos

public double getElapsedRealtimeUncertaintyNanos ()

Gets the estimate of the relative precision of the alignment of the getElapsedRealtimeNanos() timestamp, with the reported measurements in nanoseconds (68% confidence).

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

getFullBiasNanos

public long getFullBiasNanos ()

Gets the difference between hardware clock (getTimeNanos()) inside GPS receiver and the true GPS time since 0000Z, January 6, 1980, in nanoseconds.

This value is available if the receiver has estimated GPS time. If the computed time is for a non-GPS constellation, the time offset of that constellation to GPS has to be applied to fill this value. The value is only available if hasFullBiasNanos() is true.

The error estimate for the sum of this field and getBiasNanos() is getBiasUncertaintyNanos().

The sign of the value is defined by the following equation:

     local estimate of GPS time = TimeNanos - (FullBiasNanos + BiasNanos)

getHardwareClockDiscontinuityCount

public int getHardwareClockDiscontinuityCount ()

Gets count of hardware clock discontinuities.

When this value stays the same, vs. a value in a previously reported GnssClock, it can be safely assumed that the TimeNanos value has been derived from a clock that has been running continuously - e.g. a single continuously powered crystal oscillator, and thus the (FullBiasNanos + BiasNanos) offset can be modelled with traditional clock bias & drift models.

Each time this value changes, vs. the value in a previously reported GnssClock, that suggests the hardware clock may have experienced a discontinuity (e.g. a power cycle or other anomaly), so that any assumptions about modelling a smoothly changing (FullBiasNanos + BiasNanos) offset, and a smoothly growing (TimeNanos) between this and the previously reported GnssClock, should be reset.

getLeapSecond

public int getLeapSecond ()

Gets the leap second associated with the clock's time.

The sign of the value is defined by the following equation:

     UtcTimeNanos = TimeNanos - (FullBiasNanos + BiasNanos) - LeapSecond * 1,000,000,000

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

getReferenceCarrierFrequencyHzForIsb

public double getReferenceCarrierFrequencyHzForIsb ()

Returns the reference carrier frequency in Hz for inter-signal bias.

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

getReferenceCodeTypeForIsb

public String getReferenceCodeTypeForIsb ()

Returns the reference code type for inter-signal bias.

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

The return value is one of those constants defined in GnssMeasurement.getCodeType().

getReferenceConstellationTypeForIsb

public int getReferenceConstellationTypeForIsb ()

Returns the reference constellation type for inter-signal bias.

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

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

getTimeNanos

public long getTimeNanos ()

Gets the GNSS receiver internal hardware clock value in nanoseconds.

This value is expected to be monotonically increasing while the hardware clock remains powered on. For the case of a hardware clock that is not continuously on, see the getHardwareClockDiscontinuityCount() field. The GPS time can be derived by subtracting the sum of getFullBiasNanos() and getBiasNanos() (when they are available) from this value. Sub-nanosecond accuracy can be provided by means of getBiasNanos().

The error estimate for this value (if applicable) is getTimeUncertaintyNanos().

getTimeUncertaintyNanos

public double getTimeUncertaintyNanos ()

Gets the clock's time Uncertainty (1-Sigma) in nanoseconds.

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

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

This value is often effectively zero (it is the reference clock by which all other times and time uncertainties are measured), and thus this field may often be 0, or not provided.

hasBiasNanos

public boolean hasBiasNanos ()

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

hasBiasUncertaintyNanos

public boolean hasBiasUncertaintyNanos ()

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

hasDriftNanosPerSecond

public boolean hasDriftNanosPerSecond ()

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

hasDriftUncertaintyNanosPerSecond

public boolean hasDriftUncertaintyNanosPerSecond ()

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

hasElapsedRealtimeNanos

public boolean hasElapsedRealtimeNanos ()

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

hasElapsedRealtimeUncertaintyNanos

public boolean hasElapsedRealtimeUncertaintyNanos ()

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

hasFullBiasNanos

public boolean hasFullBiasNanos ()

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

hasLeapSecond

public boolean hasLeapSecond ()

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

hasReferenceCarrierFrequencyHzForIsb

public boolean hasReferenceCarrierFrequencyHzForIsb ()

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

hasReferenceCodeTypeForIsb

public boolean hasReferenceCodeTypeForIsb ()

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

hasReferenceConstellationTypeForIsb

public boolean hasReferenceConstellationTypeForIsb ()

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

hasTimeUncertaintyNanos

public boolean hasTimeUncertaintyNanos ()

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

toString

public String toString ()

Returns a string representation of the object.

writeToParcel

public void writeToParcel (Parcel parcel, 
                int flags)

Flatten this object in to a Parcel.