GPSAlmanac.java

  1. /* Copyright 2002-2019 CS Systèmes d'Information
  2.  * Licensed to CS Systèmes d'Information (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.gnss;

  19. import org.hipparchus.util.FastMath;
  20. import org.orekit.propagation.analytical.gnss.GPSOrbitalElements;
  21. import org.orekit.time.AbsoluteDate;
  22. import org.orekit.time.GPSDate;


  25. /**
  26.  * This class holds a GPS almanac as read from SEM or YUMA files.
  27.  *
  28.  * <p>Depending on the source (SEM or YUMA), some fields may be filled in or not.
  29.  * An almanac read from a YUMA file doesn't hold SVN number, average URA and satellite
  30.  * configuration.</p>
  31.  *
  32.  * @author Pascal Parraud
  33.  * @since 8.0
  34.  *
  35.  */
  36. public class GPSAlmanac implements GPSOrbitalElements {

  38.     // Fields
  39.     /** Source of the almanac. */
  40.     private final String src;
  41.     /** PRN number. */
  42.     private final int prn;
  43.     /** SVN number. */
  44.     private final int svn;
  45.     /** Health status. */
  46.     private final int health;
  47.     /** Average URA. */
  48.     private final int ura;
  49.     /** Satellite configuration. */
  50.     private final int config;
  51.     /** GPS week. */
  52.     private final int week;
  53.     /** Time of applicability. */
  54.     private final double toa;
  55.     /** Semi-major axis. */
  56.     private final double sma;
  57.     /** Eccentricity. */
  58.     private final double ecc;
  59.     /** Inclination. */
  60.     private final double inc;
  61.     /** Longitude of Orbital Plane. */
  62.     private final double om0;
  63.     /** Rate of Right Ascension. */
  64.     private final double dom;
  65.     /** Argument of perigee. */
  66.     private final double aop;
  67.     /** Mean anomaly. */
  68.     private final double anom;
  69.     /** Zeroth order clock correction. */
  70.     private final double af0;
  71.     /** First order clock correction. */
  72.     private final double af1;

  74.     /**
  75.      * Constructor.
  76.      *
  77.      * @param source the source of the almanac (SEM, YUMA, user defined)
  78.      * @param prn the PRN number
  79.      * @param svn the SVN number
  80.      * @param week the GPS week
  81.      * @param toa the Time of Applicability
  82.      * @param sqa the Square Root of Semi-Major Axis (m^1/2)
  83.      * @param ecc the eccentricity
  84.      * @param inc the inclination (rad)
  85.      * @param om0 the geographic longitude of the orbital plane at the weekly epoch (rad)
  86.      * @param dom the Rate of Right Ascension (rad/s)
  87.      * @param aop the Argument of Perigee (rad)
  88.      * @param anom the Mean Anomaly (rad)
  89.      * @param af0 the Zeroth Order Clock Correction (s)
  90.      * @param af1 the First Order Clock Correction (s/s)
  91.      * @param health the Health status
  92.      * @param ura the average URA
  93.      * @param config the satellite configuration
  94.      */
  95.     public GPSAlmanac(final String source, final int prn, final int svn,
  96.                       final int week, final double toa,
  97.                       final double sqa, final double ecc, final double inc,
  98.                       final double om0, final double dom, final double aop,
  99.                       final double anom, final double af0, final double af1,
  100.                       final int health, final int ura, final int config) {
  101.         this.src = source;
  102.         this.prn = prn;
  103.         this.svn = svn;
  104.         this.week = week;
  105.         this.toa = toa;
  106.         this.sma = sqa * sqa;
  107.         this.ecc = ecc;
  108.         this.inc = inc;
  109.         this.om0 = om0;
  110.         this.dom = dom;
  111.         this.aop = aop;
  112.         this.anom = anom;
  113.         this.af0 = af0;
  114.         this.af1 = af1;
  115.         this.health = health;
  116.         this.ura = ura;
  117.         this.config = config;
  118.     }

  120.     @Override
  121.     public AbsoluteDate getDate() {
  122.         return new GPSDate(week, toa * 1000.).getDate();
  123.     }

  125.     /**
  126.      * Gets the source of this GPS almanac.
  127.      * <p>Sources can be SEM or YUMA, when the almanac is read from a file.</p>
  128.      *
  129.      * @return the source of this GPS almanac
  130.      */
  131.     public String getSource() {
  132.         return src;
  133.     }

  135.     @Override
  136.     public int getPRN() {
  137.         return prn;
  138.     }

  140.     /**
  141.      * Gets the satellite "SVN" reference number.
  142.      *
  143.      * @return the satellite "SVN" reference number
  144.      */
  145.     public int getSVN() {
  146.         return svn;
  147.     }

  149.     @Override
  150.     public int getWeek() {
  151.         return week;
  152.     }

  154.     @Override
  155.     public double getTime() {
  156.         return toa;
  157.     }

  159.     @Override
  160.     public double getSma() {
  161.         return sma;
  162.     }

  164.     @Override
  165.     public double getMeanMotion() {
  166.         final double absA = FastMath.abs(sma);
  167.         return FastMath.sqrt(GPS_MU / absA) / absA;
  168.     }

  170.     @Override
  171.     public double getE() {
  172.         return ecc;
  173.     }

  175.     @Override
  176.     public double getI0() {
  177.         return inc;
  178.     }

  180.     @Override
  181.     public double getIDot() {
  182.         return 0;
  183.     }

  185.     @Override
  186.     public double getOmega0() {
  187.         return om0;
  188.     }

  190.     @Override
  191.     public double getOmegaDot() {
  192.         return dom;
  193.     }

  195.     @Override
  196.     public double getPa() {
  197.         return aop;
  198.     }

  200.     @Override
  201.     public double getM0() {
  202.         return anom;
  203.     }

  205.     @Override
  206.     public double getCuc() {
  207.         return 0;
  208.     }

  210.     @Override
  211.     public double getCus() {
  212.         return 0;
  213.     }

  215.     @Override
  216.     public double getCrc() {
  217.         return 0;
  218.     }

  220.     @Override
  221.     public double getCrs() {
  222.         return 0;
  223.     }

  225.     @Override
  226.     public double getCic() {
  227.         return 0;
  228.     }

  230.     @Override
  231.     public double getCis() {
  232.         return 0;
  233.     }

  235.     @Override
  236.     public double getAf0() {
  237.         return af0;
  238.     }

  240.     @Override
  241.     public double getAf1() {
  242.         return af1;
  243.     }

  245.     /**
  246.      * Gets the Health status.
  247.      *
  248.      * @return the Health status
  249.      */
  250.     public int getHealth() {
  251.         return health;
  252.     }

  254.     /**
  255.      * Gets the average URA number.
  256.      *
  257.      * @return the average URA number
  258.      */
  259.     public int getURA() {
  260.         return ura;
  261.     }

  263.     /**
  264.      * Gets the satellite configuration.
  265.      *
  266.      * @return the satellite configuration
  267.      */
  268.     public int getSatConfiguration() {
  269.         return config;
  270.     }

  272. }
Created with JaCoCo 0.8.2.201808211720