GLONASSOrbitalElements.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;

  19. import org.orekit.gnss.GLONASSAlmanac;
  20. import org.orekit.gnss.GLONASSEphemeris;
  21. import org.orekit.propagation.numerical.GLONASSNumericalPropagator;
  22. import org.orekit.time.TimeStamped;

  24. /** This interface provides the minimal set of orbital elements needed by the {@link GLONASSAnalyticalPropagator} and
  25.  * the {@link GLONASSNumericalPropagator}.
  26.  * <p>
  27.  * Because input data are different between numerical and analytical GLONASS propagators the
  28.  * methods present in this interface are implemented by default.
  29.  * Depending if the user wants to use a {@link GLONASSNumericalPropagator} or a {@link GLONASSAnalyticalPropagator}
  30.  * he can create an instance of a {@link GLONASSEphemeris} or {@link GLONASSAlmanac}.
  31.  * </p>
  32.  *
  33.  * @see <a href="http://russianspacesystems.ru/wp-content/uploads/2016/08/ICD-GLONASS-CDMA-General.-Edition-1.0-2016.pdf">
  34.  *       GLONASS Interface Control Document</a>
  35.  *
  36.  * @author Bryan Cazabonne
  37.  * @since 10.0
  38.  *
  39.  */
  40. public interface GLONASSOrbitalElements extends TimeStamped {

  42.     // Constants
  43.     /** Value of the Earth's universal gravitational parameter for GLONASS user in m³/s². */
  44.     double GLONASS_MU = 3.986004418e+14;

  46.     /** Value of Pi for conversion from semicircles to radian. */
  47.     double GLONASS_PI = 3.14159265358979;

  49.     /**
  50.      * Get the number of the current day in a four year interval.
  51.      *
  52.      * @return the number of the current day in a four year interval
  53.      */
  54.     default int getNa() {
  55.         return 0;
  56.     }

  58.     /**
  59.      * Get the number of the current four year interval.
  60.      *
  61.      * @return the number of the current four year interval
  62.      */
  63.     default int getN4() {
  64.         return 0;
  65.     }

  67.     /**
  68.      * Get the Reference Time.
  69.      *
  70.      * @return the Reference Time (s)
  71.      */
  72.     default double getTime() {
  73.         return 0.0;
  74.     }

  76.     /**
  77.      * Get the longitude of ascending node of orbit.
  78.      *
  79.      * @return the longitude of ascending node of orbit (rad)
  80.      */
  81.     default double getLambda() {
  82.         return 0.0;
  83.     }

  85.     /**
  86.      * Get the Eccentricity.
  87.      *
  88.      * @return the Eccentricity
  89.      */
  90.     default double getE() {
  91.         return 0.0;
  92.     }

  94.     /**
  95.      * Get the Argument of Perigee.
  96.      *
  97.      * @return the Argument of Perigee (rad)
  98.      */
  99.     default double getPa() {
  100.         return 0.0;
  101.     }

  103.     /**
  104.      * Get the correction to the mean value of inlination.
  105.      *
  106.      * @return the correction to the mean value of inlination (rad)
  107.      */
  108.     default double getDeltaI() {
  109.         return 0.0;
  110.     }

  112.     /**
  113.      * Get the correction to the mean value of Draconian period.
  114.      *
  115.      * @return the correction to the mean value of Draconian period (s)
  116.      */
  117.     default double getDeltaT() {
  118.         return 0.0;
  119.     }

  121.     /**
  122.      * Get the rate of change of Draconian period.
  123.      *
  124.      * @return the rate of change of Draconian period
  125.      */
  126.     default double getDeltaTDot() {
  127.         return 0.0;
  128.     }

  130.     /**
  131.      * Get the relative deviation of predicted satellite carrier frequency from nominal value.
  132.      *
  133.      * @return the relative deviation of predicted satellite carrier frequency from nominal value
  134.      */
  135.     default double getGammaN() {
  136.         return 0.0;
  137.     }

  139.     /**
  140.      * Get the correction to the satellite time relative to GLONASS system time.
  141.      *
  142.      * @return the correction to the satellite time relative to GLONASS system time (s)
  143.      *
  144.      */
  145.     default double getTN() {
  146.         return 0.0;
  147.     }

  149.     /**
  150.      * Get the ECEF-X component of satellite velocity vector in PZ-90 datum.
  151.      *
  152.      * @return the the ECEF-X component of satellite velocity vector in PZ-90 datum (m/s)
  153.      */
  154.     default double getXDot() {
  155.         return 0.0;
  156.     }

  158.     /**
  159.      * Get the ECEF-X component of satellite coordinates in PZ-90 datum.
  160.      *
  161.      * @return the ECEF-X component of satellite coordinates in PZ-90 datum (m)
  162.      */
  163.     default double getX() {
  164.         return 0.0;
  165.     }

  167.     /**
  168.      * Get the GLONASS ECEF-X component of satellite acceleration vector in PZ-90 datum.
  169.      *
  170.      * @return the GLONASS ECEF-X component of satellite acceleration vector in PZ-90 datum (m/s²)
  171.      */
  172.     default double getXDotDot() {
  173.         return 0.0;
  174.     }

  176.     /**
  177.      * Get the ECEF-Y component of satellite velocity vector in PZ-90 datum.
  178.      *
  179.      * @return the ECEF-Y component of satellite velocity vector in PZ-90 datum (m/s)
  180.      */
  181.     default double getYDot() {
  182.         return 0.0;
  183.     }

  185.     /**
  186.      * Get the ECEF-Y component of satellite coordinates in PZ-90 datum.
  187.      *
  188.      * @return the ECEF-Y component of satellite coordinates in PZ-90 datum (m)
  189.      */
  190.     default double getY() {
  191.         return 0.0;
  192.     }

  194.     /**
  195.      * Get the GLONASS ECEF-Y component of satellite acceleration vector in PZ-90 datum.
  196.      *
  197.      * @return the GLONASS ECEF-Y component of satellite acceleration vector in PZ-90 datum (m/s²)
  198.      */
  199.     default double getYDotDot() {
  200.         return 0.0;
  201.     }

  203.     /**
  204.      * Get the ECEF-Z component of satellite velocity vector in PZ-90 datum.
  205.      *
  206.      * @return the the ECEF-Z component of satellite velocity vector in PZ-90 datum (m/s)
  207.      */
  208.     default double getZDot() {
  209.         return 0.0;
  210.     }

  212.     /**
  213.      * Get the ECEF-Z component of satellite coordinates in PZ-90 datum.
  214.      *
  215.      * @return the ECEF-Z component of satellite coordinates in PZ-90 datum (m)
  216.      */
  217.     default double getZ() {
  218.         return 0.0;
  219.     }

  221.     /**
  222.      * Get the GLONASS ECEF-Z component of satellite acceleration vector in PZ-90 datum.
  223.      *
  224.      * @return the GLONASS ECEF-Z component of satellite acceleration vector in PZ-90 datum (m/s²)
  225.      */
  226.     default double getZDotDot() {
  227.         return 0.0;
  228.     }

  230.     /**
  231.      * Gets the GLONASS Issue Of Data (IOD).
  232.      *
  233.      * @return the IOD
  234.      */
  235.     default int getIOD() {
  236.         return 0;
  237.     }

  239. }
Created with JaCoCo 0.8.6.202009150832