Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 40504731 authored by Sasha Kuznetsov's avatar Sasha Kuznetsov
Browse files

Clarifiy ADR states in documentation

Bug: 167930284
Test: n/a

Change-Id: I34b7d61bcff7e43861d66c6a3cda5a77ec66ee4c
parent 2f3df6ce
Loading
Loading
Loading
Loading
+53 −2
Original line number Original line Diff line number Diff line
@@ -901,8 +901,59 @@ public final class GnssMeasurement implements Parcelable {
    /**
    /**
     * Gets 'Accumulated Delta Range' state.
     * Gets 'Accumulated Delta Range' state.
     *
     *
     * <p>It indicates whether {@link #getAccumulatedDeltaRangeMeters()} is reset or there is a
     * <p>This indicates the state of the {@link #getAccumulatedDeltaRangeMeters()} measurement. See
     * cycle slip (indicating 'loss of lock').
     * the table below for a detailed interpretation of each state.
     *
     * <table border="1">
     * <thead>
     * <tr>
     * <th>ADR_STATE</th>
     * <th>Time of relevance</th>
     * <th>Interpretation</th>
     * </tr>
     * </thead>
     * <tbody>
     * <tr>
     * <td>UNKNOWN</td>
     * <td>ADR(t)</td>
     * <td>No valid carrier phase information is available at time t.</td>
     * </tr>
     * <tr>
     * <td>VALID</td>
     * <td>ADR(t)</td>
     * <td>Valid carrier phase information is available at time t. This indicates that this
     * measurement can be used as a reference for future measurements. However, to compare it to
     * previous measurements to compute delta range, other bits should be checked. Specifically,
     * it can be used for delta range computation if it is valid and has no reset or cycle  slip at
     * this epoch i.e. if VALID_BIT == 1 && CYCLE_SLIP_BIT == 0 && RESET_BIT == 0.</td>
     * </tr>
     * <tr>
     * <td>RESET</td>
     * <td>ADR(t) - ADR(t-1)</td>
     * <td>Carrier phase accumulation has been restarted between current time t and previous time
     * t-1. This indicates that this measurement can be used as a reference for future measurements,
     * but it should not be compared to previous measurements to compute delta range.</td>
     * </tr>
     * <tr>
     * <td>CYCLE_SLIP</td>
     * <td>ADR(t) - ADR(t-1)</td>
     * <td>Cycle slip(s) have been detected between the current time t and previous time t-1. This
     * indicates that this measurement can be used as a reference for future measurements. Clients
     * can use a measurement with a cycle slip to compute delta range against previous measurements
     * at their own risk.</td>
     * </tr>
     * <tr>
     * <td>HALF_CYCLE_RESOLVED</td>
     * <td>ADR(t)</td>
     * <td>Half cycle ambiguity is resolved at time t.</td>
     * </tr>
     * <tr>
     * <td>HALF_CYCLE_REPORTED</td>
     * <td>ADR(t)</td>
     * <td>Half cycle ambiguity is reported at time t.</td>
     * </tr>
     * </tbody>
     * </table>
     */
     */
    @AdrState
    @AdrState
    public int getAccumulatedDeltaRangeState() {
    public int getAccumulatedDeltaRangeState() {