ObsClockModel.hpp

Go to the documentation of this file.

#pragma ident "$Id: ObsClockModel.hpp 3140 2012-06-18 15:03:02Z susancummins $"

//============================================================================
//
//  This file is part of GPSTk, the GPS Toolkit.
//
//  The GPSTk 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 2.1 of the License, or
//  any later version.
//
//  The GPSTk 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 GPSTk; if not, write to the Free Software Foundation,
//  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
//  
//  Copyright 2004, The University of Texas at Austin
//
//============================================================================

//============================================================================
//
//This software 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 gpstk
{
   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) throw(gpstk::InvalidValue) = 0;

      // set accessor methods ----------------------------------------------   

      ObsClockModel& setSvModeMap(const SvModeMap& right) throw();

      ObsClockModel& setSvMode(const SatID& svid, const SvMode& mode) throw()
      { modes[svid] = mode; return *this; }
      
      ObsClockModel& setSvMode(const SvMode& mode) throw()
      {
         for(int prn = 1; prn <= gpstk::MAX_PRN; prn++)
         {
            SatID svid(prn, SatID::systemGPS);
            modes[svid] = mode;
         }
         return *this;
      }

      ObsClockModel& setSigmaMultiplier(double right) throw()
      { sigmam = right; return *this; }
   
      ObsClockModel& setElevationMask(double right) throw()
      { elvmask = right; return *this; }

      ObsClockModel& setUseWonkyData(bool right) throw()
      { useWonkyData = right; return *this; }

      // get accessor methods ----------------------------------------------   
   
      const SvStatusMap& getSvStatusMap() const throw()
      { return status; };

      SvStatus getSvStatus(const SatID& svid) const throw(ObjectNotFound);

      const SvModeMap& getSvModeMap() const throw() { return modes; }

      SvMode getSvMode(const SatID& svid) const throw(ObjectNotFound);

      double getSigmaMultiplier() const throw() { return sigmam; } 

      double getElevationMask() const throw() { return elvmask; }


      bool getUseWonkyData() const throw()
      { return useWonkyData; }

      Stats<double> simpleOrdClock(const ORDEpoch& oe)
         throw(InvalidValue);

      virtual void dump(std::ostream& s, short detail=1) const throw();

      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

---