GPSAlmanac.java

  1. /* Copyright 2002-2018 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;


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  234.     /**
  235.      * Gets the Zeroth Order Clock Correction.
  236.      *
  237.      * @return the Zeroth Order Clock Correction (s)
  238.      */
  239.     public double getAf0() {
  240.         return af0;
  241.     }

  243.     /**
  244.      * Gets the First Order Clock Correction.
  245.      *
  246.      * @return the First Order Clock Correction (s/s)
  247.      */
  248.     public double getAf1() {
  249.         return af1;
  250.     }

  252.     /**
  253.      * Gets the Health status.
  254.      *
  255.      * @return the Health status
  256.      */
  257.     public int getHealth() {
  258.         return health;
  259.     }

  261.     /**
  262.      * Gets the average URA number.
  263.      *
  264.      * @return the average URA number
  265.      */
  266.     public int getURA() {
  267.         return ura;
  268.     }

  270.     /**
  271.      * Gets the satellite configuration.
  272.      *
  273.      * @return the satellite configuration
  274.      */
  275.     public int getSatConfiguration() {
  276.         return config;
  277.     }

  279. }
Created with JaCoCo 0.7.9.201702052155