NavData.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_NAVDATA_HPP
#define GNSSTK_NAVDATA_HPP
 
#include <memory>
#include <map>
#include <list>
#include "gnsstk_export.h"
#include "CommonTime.hpp"
#include "NavSignalID.hpp"
#include "NavMessageID.hpp"
#include "DumpDetail.hpp"
#include "SatMetaDataStore.hpp"
 
#ifdef SWIG
// make sure SWIG doesn't generate broken accessor methods to this data
%immutable gnsstk::NavData::satMetaDataStore;
#endif
 
namespace gnsstk
{
 
 
   class NavData; // forward declaration
 
   typedef std::shared_ptr<NavData> NavDataPtr;
   typedef std::map<CommonTime, NavDataPtr> NavMap;
   typedef std::map<NavSatelliteID, NavMap> NavSatMap;
   typedef std::map<NavMessageType, NavSatMap> NavMessageMap;
   typedef std::list<NavDataPtr> NavDataPtrList;
   typedef std::map<CommonTime, NavDataPtrList> NavNearMap;
   typedef std::map<NavSatelliteID, NavNearMap> NavNearSatMap;
   typedef std::map<NavMessageType, NavNearSatMap> NavNearMessageMap;
 
   class NavData
   {
   public:
      GNSSTK_EXPORT static const std::string dumpTimeFmt;
      GNSSTK_EXPORT static const std::string dumpTimeFmtBrief;
      NavData();
      virtual NavDataPtr clone() const = 0;
      virtual bool validate() const = 0;
      virtual std::string getClassName() const;
      virtual CommonTime getUserTime() const
      { return timeStamp + msgLenSec; }
      virtual CommonTime getNearTime() const
      { return timeStamp; }
      virtual bool isSameData(const NavDataPtr& right) const;
      virtual std::list<std::string> compare(const NavDataPtr& right) const;
      virtual void dump(std::ostream& s, DumpDetail dl) const;
      bool getSVN(const SatID& sat, const gnsstk::CommonTime& when,
                  std::string& svn)
         const
      {
         return ((satMetaDataStore != nullptr) &&
                 satMetaDataStore->getSVN(sat,when,svn));
      }
      std::string getSignalString() const;
      std::string getDumpTimeHdr(DumpDetail dl) const;
      std::string getDumpTime(DumpDetail dl, const CommonTime& t) const;
      CommonTime timeStamp;
      NavMessageID signal;
 
      GNSSTK_EXPORT static gnsstk::SatMetaDataStore *satMetaDataStore;
      static void setSatMetaDataStore(gnsstk::SatMetaDataStore *smds)
      { satMetaDataStore = smds; }
      static gnsstk::SatMetaDataStore* getSatMetaDataStore()
      { return satMetaDataStore; }
 
      std::string weekFmt;
   protected:
      double msgLenSec;
      friend class RinexNavDataFactory;
   };
 
 
}
 
#endif // GNSSTK_NAVDATA_HPP