GLOFNavAlm.hpp

Go to the documentation of this file.

//==============================================================================
//
//  This file is part of GNSSTk, the ARL:UT GNSS Toolkit.
//
//  The GNSSTk is free software; you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as published
//  by the Free Software Foundation; either version 3.0 of the License, or
//  any later version.
//
//  The GNSSTk is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public
//  License along with GNSSTk; if not, write to the Free Software Foundation,
//  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin.
//  Copyright 2004-2022, The Board of Regents of The University of Texas System
//
//==============================================================================
 
 
//==============================================================================
//
//  This software was developed by Applied Research Laboratories at the
//  University of Texas at Austin, under contract to an agency or agencies
//  within the U.S. Department of Defense. The U.S. Government retains all
//  rights to use, duplicate, distribute, disclose, or release this software.
//
//  Pursuant to DoD Directive 523024
//
//  DISTRIBUTION STATEMENT A: This software has been approved for public
//                            release, distribution is unlimited.
//
//==============================================================================
#ifndef GNSSTK_GLOFNAVALM_HPP
#define GNSSTK_GLOFNAVALM_HPP
 
#include "GLOFNavData.hpp"
#include "PZ90Ellipsoid.hpp"
#include "gnsstk_export.h"
 
namespace gnsstk
{
 
 
   class GLOFNavAlm : public GLOFNavData
   {
   public:
      GNSSTK_EXPORT static const PZ90Ellipsoid ell;
      GNSSTK_EXPORT static const double mu;
      GNSSTK_EXPORT static const double ae;
      GNSSTK_EXPORT static constexpr double omega3 = 0.7292115e-4;
      GNSSTK_EXPORT static const double icp;
      GNSSTK_EXPORT static const double Tcp;
      GNSSTK_EXPORT static const double C20;
      GNSSTK_EXPORT static const double J;
      GNSSTK_EXPORT static const double C20Term;
 
      GLOFNavAlm();
      NavDataPtr clone() const override
      { return std::make_shared<GLOFNavAlm>(*this); }
 
      bool validate() const override;
 
      bool getXvt(const CommonTime& when, Xvt& xvt,
                  const ObsID& = ObsID()) override;
 
      CommonTime getUserTime() const override;
 
      void fixFit();
 
      void dump(std::ostream& s, DumpDetail dl) const override;
 
      void dumpTerse(std::ostream& s) const;
 
      void setSemiMajorAxisIncl();
 
      class NumberCruncher
      {
      public:
         NumberCruncher();
 
         void setEccArgOfPerigee(double ecc, double omega);
         void setSemiMajorAxisIncl(double deltaT, double deltai, double omega,
                                   double ecc);
         void setLambdaBar(double M, double omega, double tau, double n);
         void setDeltas(double M, double omega, double a, double dt);
         static double getomegai(double hi, double li, double epsi);
         static double integrateEin(double Mi, double epsi);
 
         bool getXvt(const CommonTime& when, Xvt& xvt, const GLOFNavAlm& alm);
      private:
         class Deltas
         {
         public:
            Deltas();
            void setDeltas(const NumberCruncher& nc, double a, double tau,
                           double n);
            Deltas operator-(const Deltas& right) const;
            double deltaa;
            double deltah;
            double deltal;
            double deltaOMEGA;
            double deltai;
            double deltalambdaBar;
         };
            // These are all terms defined in the ICD, however I can't
            // say I know exactly what they represent, as the ICD
            // frequently doesn't, hence the absence of documentation.
            // A lot of these are values that are computed once and
            // reused several time, an optimization favoring
            // performance over memory use.
         double lambdaBar;
         double tau;
         double nu;
         double Tdeltap;        
         double n;              
         double a;              
         double i;              
         double coslambdaBar;   
         double sinlambdaBar;   
         double cos2lambdaBar;  
         double sin2lambdaBar;  
         double cos3lambdaBar;  
         double sin3lambdaBar;  
         double cos4lambdaBar;  
         double sin4lambdaBar;  
         double earthvs;        
         double sini;           
         double sini2;          
         double cosi;           
         double cosi2;          
         double JTerm;          
         double JsinTerm;       
         double Jsini2Term;     
         double Jcosi2Term;     
         double h;
         double l;
         double ecc2;           
         double ecc2obv;        
         Deltas deltas;         
         friend class Deltas;
      };
 
         // M_n^a is stored in GLOFNavData::satType
         // slot (n^A) is stored in the signal structure and GLOFNavData::slot
         // Note that in naming variables below, I've explicitly added
         // "nA" to match the ICD notation to the extent we can and to
         // hopefully reduce confusion due to overloaded variables.
      CommonTime Toa;     
      bool healthBits;    
         // This is tau sub n sup A, not to be confused with tau used
         // to compute the orbit.
      double taunA;         
      double lambdanA;      
      double deltainA;      
      double eccnA;         
      double omeganA;       
      double tLambdanA;     
      double deltaTnA;      
      double deltaTdotnA;   
      int freqnA;           
         // These data members are computed by setSemiMajorAxisIncl,
         // which should be done immediately following filling in the
         // data above and calling fixFit() when decoding a GLONASS
         // almanac.
      NumberCruncher math;  
   };
 
 
}
 
#endif // GNSSTK_GLOFNAVALM_HPP