BeidouOrbitalElements.java

  1. /* Copyright 2002-2020 CS GROUP
  2.  * Licensed to CS GROUP (CS) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * CS licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *   http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  17. package org.orekit.propagation.analytical.gnss;

  18. /** This interface provides the minimal set of orbital elements needed by the {@link BeidouPropagator}.
  19.  *
  20.  * @see <a href="http://www2.unb.ca/gge/Resources/beidou_icd_english_ver2.0.pdf">Beidou Interface Control Document</a>
  21.  * @author Bryan Cazabonne
  22.  * @since 10.0
  23.  *
  24.  */
  25. public interface BeidouOrbitalElements extends GNSSOrbitalElements {

  26.     // Constants
  27.     /** Earth's universal gravitational parameter for Beidou user in m³/s². */
  28.     double BEIDOU_MU = 3.986004418e+14;

  29.     /** Value of Pi for conversion from semicircles to radian. */
  30.     double BEIDOU_PI = 3.1415926535898;

  31.     /** Duration of the Beidou week in seconds. */
  32.     double BEIDOU_WEEK_IN_SECONDS = 604800.;

  33.     /** Number of weeks in the Beidou cycle. */
  34.     int BEIDOU_WEEK_NB = 8192;

  35.     /**
  36.      * Gets the Age Of Data Clock (AODC).
  37.      *
  38.      * @return the Age Of Data Clock (AODC)
  39.      */
  40.     default int getAODC() {
  41.         return 0;
  42.     }

  43.     /**
  44.      * Gets the Age Of Data Ephemeris (AODE).
  45.      *
  46.      * @return the Age Of Data Ephemeris (AODE)
  47.      */
  48.     default int getAODE() {
  49.         return 0;
  50.     }

  51.     /**
  52.      * Gets the BeiDou Issue Of Data (IOD).
  53.      *
  54.      * @return the IOD
  55.      */
  56.     default int getIOD() {
  57.         return 0;
  58.     }

  59.     /**
  60.      * Gets the estimated group delay differential TGD1 for B1I signal.
  61.      *
  62.      * @return the estimated group delay differential TGD1 for B1I signal (s)
  63.      */
  64.     default double getTGD1() {
  65.         return 0.0;
  66.     }

  67.     /**
  68.      * Gets the estimated group delay differential TGD for B2I signal.
  69.      *
  70.      * @return the estimated group delay differential TGD2 for B2I signal (s)
  71.      */
  72.     default double getTGD2() {
  73.         return 0.0;
  74.     }

  75. }