CCIR.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_CCIR_HPP
#define GNSSTK_CCIR_HPP
 
#include <limits>
#include <vector>
#include "CommonTime.hpp"
 
// test class forward declaration for friend.
class CCIR_T;
 
namespace gnsstk
{
   class CCIR
   {
   public:
      enum CCIRConsts
      {
         LowSolarActIdx = 0,  
         HighSolarActIdx = 1, 
            // dimensions of the CCIR data arrays
         F2SolarActCond = 2,  
         F2MaxDegree = 76,    
         F2MaxOrder = 13,     
         FM3MaxDegree = 49,   
         FM3MaxOrder = 9,     
      };
 
      CCIR();
 
      void fourier(const CommonTime& when, double effSunSpots);
 
      double getCF2(unsigned degree) const
      {
         return (cacheFourierGood && degree < cacheCF2.size()
                 ? cacheCF2[degree]
                 : std::numeric_limits<double>::quiet_NaN());
      }
 
      double getCM3(unsigned degree) const
      {
         return (cacheFourierGood && degree < cacheCM3.size()
                 ? cacheCM3[degree]
                 : std::numeric_limits<double>::quiet_NaN());
      }
 
   private:
      void validateCache(const CommonTime& when, double effSunSpots);
      void interpolate(const CommonTime& when, double effSunSpots);
      void interpolateF2(const CommonTime& when, double effSunSpots);
      void interpolateFm3(const CommonTime& when, double effSunSpots);
 
      double ccirF2(unsigned month, int cond, int deg, int ord);
      double ccirFm3(unsigned month, int cond, int deg, int ord);
      double ccir11F2(int cond, int deg, int ord);
      double ccir11Fm3(int cond, int deg, int ord);
      double ccir12F2(int cond, int deg, int ord);
      double ccir12Fm3(int cond, int deg, int ord);
      double ccir13F2(int cond, int deg, int ord);
      double ccir13Fm3(int cond, int deg, int ord);
      double ccir14F2(int cond, int deg, int ord);
      double ccir14Fm3(int cond, int deg, int ord);
      double ccir15F2(int cond, int deg, int ord);
      double ccir15Fm3(int cond, int deg, int ord);
      double ccir16F2(int cond, int deg, int ord);
      double ccir16Fm3(int cond, int deg, int ord);
      double ccir17F2(int cond, int deg, int ord);
      double ccir17Fm3(int cond, int deg, int ord);
      double ccir18F2(int cond, int deg, int ord);
      double ccir18Fm3(int cond, int deg, int ord);
      double ccir19F2(int cond, int deg, int ord);
      double ccir19Fm3(int cond, int deg, int ord);
      double ccir20F2(int cond, int deg, int ord);
      double ccir20Fm3(int cond, int deg, int ord);
      double ccir21F2(int cond, int deg, int ord);
      double ccir21Fm3(int cond, int deg, int ord);
      double ccir22F2(int cond, int deg, int ord);
      double ccir22Fm3(int cond, int deg, int ord);
 
      unsigned cacheMonth;
      double cacheHour;
      double cacheSunSpots;
      std::vector<double> cacheF2;
      std::vector<double> cacheFM3;
      std::vector<double> cacheCF2;
      std::vector<double> cacheCM3;
      bool cacheGood;
      bool cacheFourierGood;
 
      friend class ::CCIR_T;
   };
}
 
#endif // GNSSTK_CCIR_HPP