ObsClockModel.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 OBSCLOCKMODEL_HPP
#define OBSCLOCKMODEL_HPP
 
#include <map>
#include "Exception.hpp"
#include "gps_constants.hpp"
 
#include "Stats.hpp"
#include "ClockModel.hpp"
#include "ORDEpoch.hpp"
 
 
namespace gnsstk
{
 
 
   class ObsClockModel : public ClockModel
   {
   public:
      enum SvMode
      {
         IGNORE,   
         HEALTHY,  
         ALWAYS    
      };
 
      enum SvStatus
      {
         USED,      
         MANUAL,    
         SVHEALTH,  
         ELEVATION, 
         WONKY,     
         SIGMA      
      };
 
      typedef std::map<SatID, SvMode> SvModeMap;
 
      typedef std::map<SatID, SvStatus> SvStatusMap;
 
      ObsClockModel(double sigma = 2, double elmask = 0, SvMode mode = ALWAYS)
            : sigmam(sigma), elvmask(elmask), useWonkyData(false)
      {
         status.clear();
         setSvMode(mode);
      }
 
      virtual void addEpoch(const ORDEpoch& re) = 0;
 
         // set accessor methods ----------------------------------------------
 
      ObsClockModel& setSvModeMap(const SvModeMap& right) noexcept;
 
      ObsClockModel& setSvMode(const SatID& svid, const SvMode& mode) noexcept
      { modes[svid] = mode; return *this; }
 
      ObsClockModel& setSvMode(const SvMode& mode) noexcept
      {
         for(int prn = 1; prn <= gnsstk::MAX_PRN; prn++)
         {
            SatID svid(prn, SatelliteSystem::GPS);
            modes[svid] = mode;
         }
         return *this;
      }
 
      ObsClockModel& setSigmaMultiplier(double right) noexcept
      { sigmam = right; return *this; }
 
      ObsClockModel& setElevationMask(double right) noexcept
      { elvmask = right; return *this; }
 
      ObsClockModel& setUseWonkyData(bool right) noexcept
      { useWonkyData = right; return *this; }
 
         // get accessor methods ----------------------------------------------
 
      const SvStatusMap& getSvStatusMap() const noexcept
      { return status; };
 
      SvStatus getSvStatus(const SatID& svid) const;
 
      const SvModeMap& getSvModeMap() const noexcept { return modes; }
 
      SvMode getSvMode(const SatID& svid) const;
 
      double getSigmaMultiplier() const noexcept { return sigmam; }
 
      double getElevationMask() const noexcept { return elvmask; }
 
 
      bool getUseWonkyData() const noexcept
      { return useWonkyData; }
 
      Stats<double> simpleOrdClock(const ORDEpoch& oe);
 
      virtual void dump(std::ostream& s, short detail=1) const noexcept;
 
      friend std::ostream& operator<<(std::ostream& s, const ObsClockModel& r)
      { r.dump(s, 0); return s; };
 
   protected:
 
      double sigmam;        
      double elvmask;       
      SvStatusMap status;   
      SvModeMap modes;      
      bool useWonkyData;    
   };
 
 
}
#endif