Rinex3ClockHeader.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 RINEX3CLOCKHEADER_HPP
#define RINEX3CLOCKHEADER_HPP
 
#include <string>
#include <vector>
#include <map>
#include "Rinex3ClockBase.hpp"
#include "RinexSatID.hpp"
#include "RinexObsID.hpp"
#include "TimeSystem.hpp"
#include "gnsstk_export.h"
 
namespace gnsstk
{
 
 
   class Rinex3ClockHeader : public Rinex3ClockBase
   {
   public:
 
      Rinex3ClockHeader() : version(3.0), leapSeconds(0), timeSystem(TimeSystem::Any),
                            numSolnStations(0), numSolnSatellites(0)
      {}
 
 
      GNSSTK_EXPORT
      static const std::string versionString;         
      GNSSTK_EXPORT
      static const std::string runByString;           
      GNSSTK_EXPORT
      static const std::string commentString;         
      GNSSTK_EXPORT
      static const std::string sysString;             
      GNSSTK_EXPORT
      static const std::string timeSystemString;      
      GNSSTK_EXPORT
      static const std::string leapSecondsString;     
      GNSSTK_EXPORT
      static const std::string sysDCBString;          
      GNSSTK_EXPORT
      static const std::string sysPCVString;          
      GNSSTK_EXPORT
      static const std::string numDataString;         
      GNSSTK_EXPORT
      static const std::string stationNameString;     
      GNSSTK_EXPORT
      static const std::string stationClockRefString; 
      GNSSTK_EXPORT
      static const std::string analysisCenterString;  
      GNSSTK_EXPORT
      static const std::string numClockRefString;     
      GNSSTK_EXPORT
      static const std::string analysisClkRefrString; 
      GNSSTK_EXPORT
      static const std::string numReceiversString;    
      GNSSTK_EXPORT
      static const std::string solnStateString;       
      GNSSTK_EXPORT
      static const std::string numSolnSatsString;     
      GNSSTK_EXPORT
      static const std::string prnListString;         
      GNSSTK_EXPORT
      static const std::string endOfHeaderString;     
 
 
      enum validBits
      {
         versionValid            = 0x01, 
         runByValid              = 0x02, 
         commentValid            = 0x04, 
         sysValid                = 0x08, 
 
         timeSystemValid        = 0x010, 
         leapSecondsValid       = 0x020, 
         sysDCBValid            = 0x040, 
         sysPCVValid            = 0x080, 
 
         numDataValid          = 0x0100, 
         stationNameValid      = 0x0200, 
         stationClockRefValid  = 0x0400, 
         analysisCenterValid   = 0x0800, 
 
         numClockRefValid     = 0x01000, 
         analysisClkRefrValid = 0x02000, 
         numReceiversValid    = 0x04000, 
         solnStateValid       = 0x08000, 
 
         numSolnSatsValid    = 0x010000, 
         prnListValid        = 0x020000, 
         endOfHeaderValid    = 0x040000, 
 
            //allRequiredValid    = 0x07F9A3, ///< this mask if for all required fields
            //allRequiredValid    = 0x07F903, ///< this mask if for all required fields
         allRequiredValid    = 0x07C903, 
         allValid            = 0x07FFFF  
      };
 
      virtual ~Rinex3ClockHeader() {}
 
         // The next four lines is our common interface
      virtual bool isHeader() const { return true; }
 
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Woverloaded-virtual"
      virtual void dump(std::ostream& s=std::cout, short detail = 0) const noexcept;
#pragma clang diagnostic pop
 
      void dumpValid(std::ostream& s=std::cout) const noexcept;
 
      double version;                        
      std::string program;                   
      std::string runby;                     
      std::string fileSys;                   
      std::vector<std::string> dataTypes;    
 
      std::string satSysPrev;
      int numObs;
      typedef std::map<std::string, std::vector<RinexObsID> > RinexObsMap;
      RinexObsMap sysObsTypes;               
 
      int leapSeconds;                       
      TimeSystem timeSystem;                 
 
      std::string analCenterDesignator;      
      std::string analysisCenter;            
      std::string terrRefFrame;              
         // system letter, program name, and source of code bias corrections
      typedef std::pair<std::string,std::string> stringPair;
      std::map<std::string, stringPair > dcbsMap;
         // system letter, program name, and source of phase center corrections
      std::map<std::string, stringPair > pcvsMap;
 
 
      int numSolnStations;                   
      std::map<std::string,std::string> stationID; 
         // NB these coordinates are often more than 32 bits -- cannot store as number!
      std::map<std::string,std::string> stationX;  
      std::map<std::string,std::string> stationY;  
      std::map<std::string,std::string> stationZ;  
 
      int numSolnSatellites;                  
      std::vector<RinexSatID> satList;        
 
      std::vector<std::string> commentList;   
 
      unsigned long valid;                    
 
   protected:
      void clear(void)
      {
         version = 3.0;
         program = std::string();
         runby = std::string();
         dataTypes.clear();
         leapSeconds = 0;
         analysisCenter = std::string();
         terrRefFrame = std::string();
         timeSystem = TimeSystem::Any;
         dcbsMap.clear();
         pcvsMap.clear();
         numSolnStations = 0;
         stationID.clear();
         stationX.clear();
         stationY.clear();
         stationZ.clear();
         numSolnSatellites = 0;
         satList.clear();
         commentList.clear();
 
         valid = 0;
      }
 
      virtual void reallyPutRecord(FFStream& s) const;
 
      virtual void reallyGetRecord(FFStream& s);
 
   }; // end class Rinex3ClockHeader
 
 
}  // namespace
 
#endif // RINEX3CLOCKHEADER_HPP