/* 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.propagation.analytical.gnss.data;
  
  import org.hipparchus.CalculusFieldElement;
  import org.hipparchus.Field;
  import org.orekit.gnss.SatelliteSystem;
  import org.orekit.time.TimeScales;
  
  /**
   * Container for data contained in a BeiDou navigation message.
   * @author Bryan Cazabonne
   * @since 11.0
   */
  public class BeidouLegacyNavigationMessage extends AbstractNavigationMessage<BeidouLegacyNavigationMessage> {
  
      /** Identifier for message type. */
      public static final String D1 = "D1";
  
      /** Identifier for message type. */
      public static final String D2 = "D2";
  
      /** Age of Data, Ephemeris. */
      private int aode;
  
      /** Age of Data, Clock. */
      private int aodc;
  
      /** Health identifier.
       * @since 14.0
       */
      private int satH1;
  
      /** B1/B3 Group Delay Differential (s). */
      private double tgd1;
  
      /** B2/B3 Group Delay Differential (s). */
      private double tgd2;
  
      /** The user SV accuracy (m). */
      private double svAccuracy;
  
      /** Constructor.
       * @param timeScales known time scales
       * @param system     satellite system to consider for interpreting week number
       *                   (may be different from real system, for example in Rinex nav, weeks
       *                   are always according to GPS)
       * @param type       message type
       */
      public BeidouLegacyNavigationMessage(final TimeScales timeScales,
                                           final SatelliteSystem system,
                                           final String type) {
          super(GNSSConstants.BEIDOU_MU, GNSSConstants.BEIDOU_AV, GNSSConstants.BEIDOU_WEEK_NB,
                timeScales, system, type);
      }
  
      /** Constructor from field instance.
       * @param <T> type of the field elements
       * @param original regular field instance
       */
      public <T extends CalculusFieldElement<T>> BeidouLegacyNavigationMessage(final FieldBeidouLegacyNavigationMessage<T> original) {
          super(original);
          setAODE(original.getAODE());
          setAODC(original.getAODC());
          setTGD1(original.getTGD1().getReal());
          setTGD2(original.getTGD2().getReal());
          setSvAccuracy(original.getSvAccuracy().getReal());
          setSatH1(original.getSatH1());
      }
  
      /** {@inheritDoc} */
      @SuppressWarnings("unchecked")
      @Override
      public <T extends CalculusFieldElement<T>, F extends FieldGnssOrbitalElements<T, BeidouLegacyNavigationMessage>>
          F toField(final Field<T> field) {
          return (F) new FieldBeidouLegacyNavigationMessage<>(field, this);
      }
  
      /**
       * Getter for the Age Of Data Clock (AODC).
       * @return the Age Of Data Clock (AODC)
       */
      public int getAODC() {
          return aodc;
      }
 
     /**
      * Setter for the age of data clock.
      * @param aod the age of data to set
      */
     public void setAODC(final double aod) {
         // The value is given as a floating number in the navigation message
         this.aodc = (int) aod;
     }
 
     /**
      * Getter for the Age Of Data Ephemeris (AODE).
      * @return the Age Of Data Ephemeris (AODE)
      */
     public int getAODE() {
         return aode;
     }
 
     /**
      * Setter for the age of data ephemeris.
      * @param aod the age of data to set
      */
     public void setAODE(final double aod) {
         // The value is given as a floating number in the navigation message
         this.aode = (int) aod;
     }
 
     /**
      * Getter for the estimated group delay differential TGD1 for B1I signal.
      * @return the estimated group delay differential TGD1 for B1I signal (s)
      */
     public double getTGD1() {
         return tgd1;
     }
 
     /**
      * Setter for the B1/B3 Group Delay Differential (s).
      * @param tgd the group delay differential to set
      */
     public void setTGD1(final double tgd) {
         this.tgd1 = tgd;
     }
 
     /**
      * Getter for the estimated group delay differential TGD for B2I signal.
      * @return the estimated group delay differential TGD2 for B2I signal (s)
      */
     public double getTGD2() {
         return tgd2;
     }
 
     /**
      * Setter for the B2/B3 Group Delay Differential (s).
      * @param tgd the group delay differential to set
      */
     public void setTGD2(final double tgd) {
         this.tgd2 = tgd;
     }
 
     /**
      * Getter for the user SV accuray (meters).
      * @return the user SV accuracy
      */
     public double getSvAccuracy() {
         return svAccuracy;
     }
 
     /**
      * Setter for the user SV accuracy.
      * @param svAccuracy the value to set
      */
     public void setSvAccuracy(final double svAccuracy) {
         this.svAccuracy = svAccuracy;
     }
 
     /** Get the health identifier.
      * @return health identifier
      * @since 14.0
      */
     public int getSatH1() {
         return satH1;
     }
 
     /** Set the health identifier.
      * @param satH1 health identifier
      * @since 14.0
      */
     public void setSatH1(final int satH1) {
         this.satH1 = satH1;
     }
 
 }