FieldBeidouAlmanac.java

/* Copyright 2022-2026 Luc Maisonobe
 * 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.propagation.analytical.gnss.data;

import org.hipparchus.CalculusFieldElement;
import org.orekit.orbits.FieldKeplerianOrbit;
import org.orekit.time.FieldGNSSDate;
import org.orekit.time.TimeScales;

import java.util.function.Function;

/**
 * Class for BeiDou almanac.
 *
 * @see "BeiDou Navigation Satellite System, Signal In Space, Interface Control Document,
 *      Version 2.1, Table 5-12"
 *
 * @param <T> type of the field elements
 * @author Luc Maisonobe
 * @since 13.0
 *
 */
public class FieldBeidouAlmanac<T extends CalculusFieldElement<T>>
    extends FieldGnssOrbitalElements<T, BeidouAlmanac> {

    /** Health status. */
    private final int health;

    /** Creates a new instance.
     * @param angularVelocity mean angular velocity of the Earth for the GNSS model
     * @param weeksInCycle    number of weeks in the GNSS cycle
     * @param timeScales      known time scales
     * @param type            type (null if not a navigation message)
     * @param prn             PRN number of the satellite
     * @param toe             time of ephemeris (<em>must</em> be consistent with {@code orbit})
     * @param orbit           Keplerian orbit in Earth-frozen frame
     * @param nonKeplerian    15 non-Keplerian parameters (in the order given by {@link NonKeplerianDriversFactory}
     * @param tgd             group delay differential TGD for L1-L2 correction
     * @param toc             time of clock
     * @param health          health status
     * @since 14.0
     */
    public FieldBeidouAlmanac(final double angularVelocity, final int weeksInCycle,
                              final TimeScales timeScales, final String type, final int prn,
                              final FieldGNSSDate<T> toe, final FieldKeplerianOrbit<T> orbit,
                              final T[] nonKeplerian, final T tgd, final FieldGNSSDate<T> toc, final int health) {
        super(angularVelocity, weeksInCycle, timeScales, type, prn, toe, orbit, nonKeplerian, tgd, toc);
        this.health = health;
    }

    /** {@inheritDoc} */
    @Override
    public BeidouAlmanac toNonField() {
        return new BeidouAlmanac(this);
    }

    /** {@inheritDoc} */
    @Override
    public <U extends CalculusFieldElement<U>>
        FieldBeidouAlmanac<U> toField(final FieldKeplerianOrbit<U> orbit,
                                      final U[] nonKeplerian,
                                      final Function<T, U> converter) {
        return new FieldBeidouAlmanac<>(getAngularVelocity(), getWeeksInCycle(), getTimeScales(),
                                        getType(), getPrn(),
                                        new FieldGNSSDate<>(orbit.getDate().getField(),
                                                            getTimeOfEphemeris().getGnssDate()),
                                        orbit, nonKeplerian,
                                        converter.apply(getTgd()),
                                        new FieldGNSSDate<>(orbit.getDate().getField(),
                                                            getTimeOfClock().getGnssDate()),
                                        getHealth());
    }

    /** Gets the Health status.
     * @return the Health status
     */
    public int getHealth() {
        return health;
    }

}