ObsID.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 OBSID_HPP
#define OBSID_HPP
 
#include <iostream>
#include <iomanip>
#include <sstream>
#include <string>
#include <map>
 
#include "gnsstk_export.h"
#include "Exception.hpp"
#include "SatID.hpp"
#include "Rinex3ObsBase.hpp"
#include "ObservationType.hpp"
#include "CarrierBand.hpp"
#include "TrackingCode.hpp"
#include "XmitAnt.hpp"
 
// forward declaration of test class
class ObsID_T;
 
namespace gnsstk
{
   class ObsID;
   namespace StringUtils
   {
      std::string asString(const ObsID& id);
   }
 
 
   std::ostream& operator<<(std::ostream& s, const ObsID& p);
 
 
   class ObsID
   {
   public:
      ObsID()
            : type(ObservationType::Unknown), band(CarrierBand::Unknown),
              code(TrackingCode::Unknown), freqOffs(0), freqOffsWild(true),
              mcode(0), mcodeMask(0), xmitAnt(XmitAnt::Any)
      {}
 
      ObsID(ObservationType ot, CarrierBand cb, TrackingCode tc,
            XmitAnt transmitter = XmitAnt::Any)
            : type(ot), band(cb), code(tc), freqOffs(0), freqOffsWild(true),
              mcode(0), mcodeMask(0), xmitAnt(transmitter)
      {}
 
      explicit ObsID(ObservationType ot, CarrierBand cb, TrackingCode tc,
                     int fo, XmitAnt transmitter = XmitAnt::Any,
                     bool fw = false)
            : type(ot), band(cb), code(tc), freqOffs(fo), freqOffsWild(fw),
              mcode(0), mcodeMask(0), xmitAnt(transmitter)
      {}
 
      explicit ObsID(ObservationType ot, CarrierBand cb, TrackingCode tc,
                     int fo, uint32_t mc,
                     XmitAnt transmitter = XmitAnt::Standard, bool fw = false)
            : type(ot), band(cb), code(tc), freqOffs(fo), freqOffsWild(fw),
              mcode(mc), mcodeMask(-1), xmitAnt(transmitter)
      {}
 
      virtual bool operator==(const ObsID& right) const;
 
      virtual bool operator<(const ObsID& right) const;
 
      bool operator!=(const ObsID& right) const
      { return !(operator==(right)); };
 
      bool operator>(const ObsID& right) const
      {  return (!operator<(right) && !operator==(right)); };
 
      bool operator<=(const ObsID& right) const
      { return (operator<(right) || operator==(right)); };
 
      bool operator>=(const ObsID& right) const
      { return !(operator<(right)); };
 
      virtual std::ostream& dump(std::ostream& s) const;
 
      virtual ~ObsID()
      {}
 
      void makeWild();
 
      bool isWild() const;
 
      void setMcodeBits(uint32_t newval, uint32_t newmask = -1)
      { mcode = newval; mcodeMask = newmask; }
      void maskMcodeBits(uint32_t newval, uint32_t newmask)
      {
         mcode = (mcode & ~newmask) | (newval & newmask);
         mcodeMask |= newmask;
      }
      uint32_t getMcodeBits() const
      { return mcode; }
      void setMcodeMask(uint32_t newmask = -1)
      { mcodeMask = newmask; }
      void clearMcodeMask(uint32_t clearmask)
      { mcodeMask = mcodeMask & ~clearmask; }
      uint32_t getMcodeMask() const
      { return mcodeMask; }
 
         // Note that these are the only data members of objects of this class.
      ObservationType  type;
      CarrierBand      band;
      TrackingCode     code;
      XmitAnt xmitAnt;    
      int freqOffs;       
      bool freqOffsWild;  
 
      static std::string getDescTC(TrackingCode e)
      { return tcDesc[e]; }
      static std::string getDescCB(CarrierBand e)
      { return cbDesc[e]; }
      static std::string getDescOT(ObservationType e)
      { return otDesc[e]; }
      GNSSTK_EXPORT static std::map< TrackingCode,    std::string > tcDesc;
      GNSSTK_EXPORT static std::map< CarrierBand,     std::string > cbDesc;
      GNSSTK_EXPORT static std::map< ObservationType, std::string > otDesc;
      GNSSTK_EXPORT static bool verbose;
 
   private:
      uint32_t mcode;     
      uint32_t mcodeMask; 
      friend class ::ObsID_T;
   }; // class ObsID
 
 
} // namespace gnsstk
#endif   // OBSID_HPP