RinexMetHeader.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_RINEXMETHEADER_HPP
#define GNSSTK_RINEXMETHEADER_HPP
 
#include <vector>
#include "gnsstk_export.h"
#include "StringUtils.hpp"
#include "FFStream.hpp"
#include "RinexMetBase.hpp"
#include "Triple.hpp"
 
namespace gnsstk
{
 
 
 
   class RinexMetHeader : public RinexMetBase
   {
 
   public:
 
         // forward declarations
      struct sensorType;
 
      struct sensorPosType;
 
      enum RinexMetType
      {
         PR, 
         TD, 
         HR, 
         ZW, 
         ZD, 
         ZT, 
         WD, 
         WS, 
         RI, 
         HI  
      };
 
      RinexMetHeader() : valid(0), version(2.1) {}
 
      virtual ~RinexMetHeader() {}
 
         // The next four lines is our common interface
      virtual bool isHeader(void) const {return true;}
 
      virtual void dump(std::ostream& s) const;
 
      static RinexMetType convertObsType(const std::string& oneObs);
 
      static std::string convertObsType(const RinexMetType& oneObs);
 
      unsigned long valid;
 
      enum validBits
      {
         validVersion      = 0x01,   
         validRunBy        = 0x02,   
         validComment      = 0x04,   
         validMarkerName   = 0x08,   
         validMarkerNumber = 0x010,  
         validObsType      = 0x020,  
         validSensorType   = 0x040,  
         validSensorPos    = 0x080,  
 
         validEoH = 0x080000000,     
 
         allValid20  = 0x0800000EB,
         allValid21  = 0x0800000EB,
         allValid211 = 0x0800000EB
      };
 
      static inline std::string bitsAsString(validBits b)
      {
         switch (b)
         {
            case validVersion:
               return stringVersion;
            case validRunBy:
               return stringRunBy;
            case validComment:
               return stringComment;
            case validMarkerName:
               return stringMarkerName;
            case validMarkerNumber:
               return stringMarkerNumber;
            case validObsType:
               return stringObsType;
            case validSensorType:
               return stringSensorType;
            case validSensorPos:
               return stringSensorPos;
            case validEoH:
               return stringEoH;
            default: break; //NB Determine if additional enumeration values need to be handled
         }
 
         return "*UNKNOWN/INVALID BITS*";
      }
 
         /* @return a string composed the RINEX header strings
          * represented by the validBits set in vb, surrounded by the
          * quote character, separated by sep.
          * @param vb bit field with valid bits set
          * @param quote quote character to use around RINEX header strings.
          * @param sep separator used between rinex header strings.
          */
      static std::string bitString(unsigned long vb, char quote='\"',
                                   std::string sep=", ");
 
      bool compare(const RinexMetHeader& right,
                   std::vector<std::string>& diffs,
                   const std::vector<std::string>& inclExclList,
                   bool incl = false);
 
 
      double version; 
 
      std::string fileType;                      
      std::string fileProgram;                   
      std::string fileAgency;                    
      std::string date;                          
      std::vector<std::string> commentList;      
      std::string markerName;                    
      std::string markerNumber;                  
 
      std::vector<RinexMetType> obsTypeList;
      std::vector<sensorType> sensorTypeList;    
      std::vector<sensorPosType> sensorPosList;  
 
      GNSSTK_EXPORT
      static const int maxObsPerLine;       
 
      GNSSTK_EXPORT
      static const std::string stringVersion;       
      GNSSTK_EXPORT
      static const std::string stringRunBy;         
      GNSSTK_EXPORT
      static const std::string stringComment;       
      GNSSTK_EXPORT
      static const std::string stringMarkerName;    
      GNSSTK_EXPORT
      static const std::string stringMarkerNumber;  
      GNSSTK_EXPORT
      static const std::string stringObsType;       
      GNSSTK_EXPORT
      static const std::string stringSensorType;    
      GNSSTK_EXPORT
      static const std::string stringSensorPos;     
      GNSSTK_EXPORT
      static const std::string stringEoH;           
 
#ifndef SWIG // nested structs not supported by SWIG
      struct sensorType
      {
         std::string model;    
         std::string type;     
         double accuracy;      
         RinexMetHeader::RinexMetType obsType; 
         bool operator==(const sensorType& r) const;
         bool operator<(const sensorType& r) const;
      };
#endif
 
 
#ifndef SWIG // nested structs not supported by SWIG
      struct sensorPosType
      {
         gnsstk::Triple position;
         double height;
         RinexMetHeader::RinexMetType obsType;
         bool operator==(const sensorPosType& r) const;
         bool operator<(const sensorPosType& r) const;
      };
#endif
 
   protected:
 
      virtual void reallyPutRecord(FFStream& s) const;
 
      virtual void reallyGetRecord(FFStream& s);
 
   }; // class RinexMetHeader
 
 
} // namespace
 
#endif