NavDataFactoryWithStore.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_NAVDATAFACTORYWITHSTORE_HPP
#define GNSSTK_NAVDATAFACTORYWITHSTORE_HPP
 
#include "NavDataFactory.hpp"
#include "TimeOffsetData.hpp"
#include "StdNavTimeOffset.hpp"
 
namespace gnsstk
{
 
 
   class NavDataFactoryWithStore : public NavDataFactory
   {
   public:
         // Time offset information is organized differently due to the use case
      typedef std::map<NavSatelliteID, NavDataPtr> OffsetMap;
      typedef std::map<CommonTime, OffsetMap> OffsetEpochMap;
      typedef std::map<TimeCvtKey, OffsetEpochMap> OffsetCvtMap;
 
      NavDataFactoryWithStore();
 
      virtual ~NavDataFactoryWithStore()
      {
      }
 
      bool find(const NavMessageID& nmid, const CommonTime& when,
                NavDataPtr& navOut, SVHealth xmitHealth, NavValidityType valid,
                NavSearchOrder order) override;
 
      bool getOffset(TimeSystem fromSys, TimeSystem toSys,
                     const CommonTime& when, NavDataPtr& offset,
                     SVHealth xmitHealth = SVHealth::Any,
                     NavValidityType valid = NavValidityType::ValidOnly)
         override;
 
      void edit(const CommonTime& fromTime, const CommonTime& toTime) override;
 
      void edit(const CommonTime& fromTime, const CommonTime& toTime,
                const NavSatelliteID& satID) override;
 
      void edit(const CommonTime& fromTime, const CommonTime& toTime,
                const NavSignalID& signal) override;
 
      void clear() override;
 
      bool addNavData(const NavDataPtr& nd)
      { return addNavData(nd, data, nearestData, offsetData); }
 
      bool addNavData(const NavDataPtr& nd, NavMessageMap& navMap,
                      NavNearMessageMap& navNearMap, OffsetCvtMap& ofsMap);
 
      CommonTime getInitialTime() const override
      { return initialTime; }
 
      CommonTime getFinalTime() const override
      { return finalTime; }
 
      CommonTime getFirstTime(const SatID& sat) const;
 
      CommonTime getLastTime(const SatID& sat) const;
 
      NavSatelliteIDSet getAvailableSats(const CommonTime& fromTime,
                                         const CommonTime& toTime)
         const override;
 
      NavSatelliteIDSet getAvailableSats(NavMessageType nmt,
                                         const CommonTime& fromTime,
                                         const CommonTime& toTime)
         const override;
 
      std::set<SatID> getIndexSet(const CommonTime& fromTime,
                                  const CommonTime& toTime) const;
 
      std::set<SatID> getIndexSet(NavMessageType nmt,
                                  const CommonTime& fromTime,
                                  const CommonTime& toTime) const;
 
      NavMessageIDSet getAvailableMsgs(const CommonTime& fromTime,
                                       const CommonTime& toTime) const override;
 
      virtual size_t size() const;
      virtual size_t count(const NavMessageID& nmid) const;
      virtual size_t count(SatelliteSystem sys,
                           NavMessageType nmt = NavMessageType::Unknown)
         const;
      virtual size_t count(const SatID& satID,
                           NavMessageType nmt = NavMessageType::Unknown)
         const;
      virtual size_t count(NavMessageType nmt) const;
      virtual size_t numSignals() const;
      virtual size_t numSatellites() const;
      void dump(std::ostream& s, DumpDetail dl) const override;
      const NavMessageMap& getNavMessageMap() const
      { return data; }
      const NavNearMessageMap& getNavNearMessageMap() const
      { return nearestData; }
      const OffsetCvtMap& getTimeOffsetMap() const
      { return offsetData; }
      const NavMap* getNavMap(const NavMessageID& nmid) const;
 
   protected:
      virtual bool findUser(const NavMessageID& nmid, const CommonTime& when,
                            NavDataPtr& navData, SVHealth xmitHealth,
                            NavValidityType valid);
 
      virtual bool findNearest(const NavMessageID& nmid, const CommonTime& when,
                               NavDataPtr& navData, SVHealth xmitHealth,
                               NavValidityType valid);
 
      bool validityCheck(const NavMap::iterator& ti,
                         NavMap& nm,
                         NavValidityType valid,
                         SVHealth xmitHealth,
                         const CommonTime& when);
 
      bool validityCheck(const NavDataPtr& ndp,
                         NavValidityType valid,
                         SVHealth xmitHealth,
                         const CommonTime& when);
 
      bool matchHealth(NavData *ndp, SVHealth xmitHealth);
 
      bool updateInitialFinal(const CommonTime& begin, const CommonTime& end);
 
      NavMessageMap data;
      NavNearMessageMap nearestData;
      OffsetCvtMap offsetData;
      CommonTime initialTime;
      CommonTime finalTime;
      std::map<SatID,std::pair<CommonTime,CommonTime> > firstLastMap;
 
      friend class MultiFormatNavDataFactory;
      friend class NavDataFactoryStoreCallback;
 
   private:
      class UniqueTimeOffset
      {
      public:
         bool operator()(const std::shared_ptr<StdNavTimeOffset>& left,
                         const std::shared_ptr<StdNavTimeOffset>& right) const;
      };
 
      using TOUSet = std::set<std::shared_ptr<StdNavTimeOffset>,
                              UniqueTimeOffset>;
      using TOUSatMap = std::map<SatID, TOUSet>;
      using TOUSigMap = std::map<NavSignalID, TOUSet>;
 
      TOUSatMap touBySV;  
      TOUSigMap touBySig; 
   };
 
 
}
 
#endif // GNSSTK_NAVDATAFACTORYWITHSTORE_HPP