IonoModel.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_IONOMODEL_HPP
#define GNSSTK_IONOMODEL_HPP
 
#include "CommonTime.hpp"
#include "CarrierBand.hpp"
#include "EngAlmanac.hpp"
#include "Position.hpp"
 
namespace gnsstk
{
 
 
   class IonoModel
   {
   public:
 
      NEW_EXCEPTION_CLASS(InvalidIonoModel, gnsstk::Exception);
 
      IonoModel() noexcept : valid(false) {}
 
      virtual ~IonoModel() noexcept {}
 
      IonoModel(const double a[4], const double b[4],
                const bool semicircle_units = true) noexcept;
 
      IonoModel(const EngAlmanac& engalm) noexcept;
 
      void setModel(const double a[4], const double b[4],
                    const bool semicircle_units = true) noexcept;
 
      bool isValid() const noexcept
      { return valid; }
 
      double getCorrection(const CommonTime& time,
                           const Position& rxgeo,
                           double svel,
                           double svaz,
                           CarrierBand band = CarrierBand::L1) const;
 
      bool operator==(const IonoModel& right) const noexcept;
 
      bool operator!=(const IonoModel& right) const noexcept;
 
      bool getModel(double a[4], double b[4]) const noexcept;
 
      virtual void dump(std::ostream& s=std::cout) const;
 
   private:
 
      double alpha[4];
      double beta[4];
 
      bool valid;
   };
 
}  // namespace gnsstk
 
#endif  // GNSSTK_IONOMODEL_HPP