CivilianNavigationParser.java

/* Copyright 2002-2025 CS GROUP
 * Licensed to CS GROUP (CS) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * CS licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.orekit.files.rinex.navigation.parsers.ephemeris;

import org.orekit.files.rinex.navigation.RinexNavigationParser;
import org.orekit.files.rinex.navigation.parsers.ParseInfo;
import org.orekit.files.rinex.navigation.parsers.RecordLineParser;
import org.orekit.propagation.analytical.gnss.data.CivilianNavigationMessage;
import org.orekit.utils.units.Unit;

/** Parser for GPS civilian.
 * @param <T> type of the navigation message
 * @author Bryan Cazabonne
 * @author Luc Maisonobe
 * @since 14.0
 */
public abstract class CivilianNavigationParser<T extends CivilianNavigationMessage<T>> extends RecordLineParser {

    /** Container for parsing data. */
    private final ParseInfo parseInfo;

    /** Container for navigation message. */
    private final T message;

    /** Simple constructor.
     * @param parseInfo container for parsing data
     * @param message container for navigation message
     */
    protected CivilianNavigationParser(final ParseInfo parseInfo, final T message) {
        this.parseInfo = parseInfo;
        this.message   = message;
    }

    /** Get the container for parsing data.
     * @return container for parsing data
     */
    public ParseInfo getParseInfo() {
        return parseInfo;
    }

    /** Get the container for the navigation message.
     * @return container for the navigation message
     */
    public T getMessage() {
        return message;
    }

    /** {@inheritDoc} */
    @Override
    public void parseLine00() {
        parseSvEpochSvClockLine(parseInfo.getTimeScales().getGPS(), parseInfo, message);
    }

    /** {@inheritDoc} */
    @Override
    public void parseLine01() {
        message.setADot(parseInfo.parseDouble1(RinexNavigationParser.M_PER_S));
        message.setCrs(parseInfo.parseDouble2(Unit.METRE));
        message.setDeltaN0(parseInfo.parseDouble3(RinexNavigationParser.RAD_PER_S));
        message.setM0(parseInfo.parseDouble4(Unit.RADIAN));
    }

    /** {@inheritDoc} */
    @Override
    public void parseLine02() {
        message.setCuc(parseInfo.parseDouble1(Unit.RADIAN));
        message.setE(parseInfo.parseDouble2(Unit.NONE));
        message.setCus(parseInfo.parseDouble3(Unit.RADIAN));
        message.setSqrtA(parseInfo.parseDouble4(RinexNavigationParser.SQRT_M));
    }

    /** {@inheritDoc} */
    @Override
    public void parseLine03() {
        message.setTime(parseInfo.parseDouble1(Unit.SECOND));
        message.setCic(parseInfo.parseDouble2(Unit.RADIAN));
        message.setOmega0(parseInfo.parseDouble3(Unit.RADIAN));
        message.setCis(parseInfo.parseDouble4(Unit.RADIAN));
    }

    /** {@inheritDoc} */
    @Override
    public void parseLine04() {
        message.setI0(parseInfo.parseDouble1(Unit.RADIAN));
        message.setCrc(parseInfo.parseDouble2(Unit.METRE));
        message.setPa(parseInfo.parseDouble3(Unit.RADIAN));
        message.setOmegaDot(parseInfo.parseDouble4(RinexNavigationParser.RAD_PER_S));
    }

    /** {@inheritDoc} */
    @Override
    public void parseLine05() {
        message.setIDot(parseInfo.parseDouble1(RinexNavigationParser.RAD_PER_S));
        message.setDeltaN0Dot(parseInfo.parseDouble2(RinexNavigationParser.RAD_PER_S2));
        message.setUraiNed0(parseInfo.parseInt3());
        message.setUraiNed1(parseInfo.parseInt4());
    }

    /** {@inheritDoc} */
    @Override
    public void parseLine06() {
        message.setUraiEd(parseInfo.parseInt1());
        message.setSvHealth(parseInfo.parseInt2());
        message.setTGD(parseInfo.parseDouble3(Unit.SECOND));
        message.setUraiNed2(parseInfo.parseInt4());
    }

    /** {@inheritDoc} */
    @Override
    public void parseLine07() {
        message.setIscL1CA(parseInfo.parseDouble1(Unit.SECOND));
        message.setIscL2C(parseInfo.parseDouble2(Unit.SECOND));
        message.setIscL5I5(parseInfo.parseDouble3(Unit.SECOND));
        message.setIscL5Q5(parseInfo.parseDouble4(Unit.SECOND));
    }

    /** {@inheritDoc} */
    @Override
    public void parseLine08() {
        if (message.isCnv2()) {
            // in CNAV2 messages, there is an additional line for L1 CD and L1 CP inter signal delay
            message.setIscL1CD(parseInfo.parseDouble1(Unit.SECOND));
            message.setIscL1CP(parseInfo.parseDouble2(Unit.SECOND));
        } else {
            parseTransmissionTimeLine();
        }
    }

    /** {@inheritDoc} */
    @Override
    public void parseLine09() {
        parseTransmissionTimeLine();
    }

    /** Parse transmission time line.
     */
    protected void parseTransmissionTimeLine() {
        message.setTransmissionTime(parseInfo.parseDouble1(Unit.SECOND));
        message.setWeek(parseInfo.parseInt2());
        message.setFlags(getParseInfo().parseInt3());
        parseInfo.closePendingRecord();
    }

}