NavDataFactory.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_NAVDATAFACTORY_HPP
#define GNSSTK_NAVDATAFACTORY_HPP
 
#include <memory>
#include <map>
#include "NavSignalID.hpp"
#include "CommonTime.hpp"
#include "NavData.hpp"
#include "NavValidityType.hpp"
#include "NavMessageID.hpp"
#include "NavSearchOrder.hpp"
#include "SVHealth.hpp"
#include "FactoryControl.hpp"
 
namespace gnsstk
{
 
 
   class NavDataFactory
   {
   public:
      NavDataFactory()
            : navValidity(NavValidityType::Any),
              procNavTypes(allNavMessageTypes)
      {}
 
      virtual ~NavDataFactory()
      {
      }
 
      virtual std::string getClassName() const;
 
      virtual bool find(const NavMessageID& nmid, const CommonTime& when,
                        NavDataPtr& navOut, SVHealth xmitHealth,
                        NavValidityType valid, NavSearchOrder order) = 0;
 
      virtual bool getOffset(TimeSystem fromSys, TimeSystem toSys,
                             const CommonTime& when, NavDataPtr& offset,
                             SVHealth xmitHealth = SVHealth::Any,
                             NavValidityType valid = NavValidityType::ValidOnly) = 0;
 
      virtual void setValidityFilter(NavValidityType nvt)
      { navValidity = nvt; }
 
      virtual void setTypeFilter(const NavMessageTypeSet& nmts)
      { procNavTypes = nmts; }
 
      NavMessageTypeSet getTypeFilter() const
      { return procNavTypes; }
 
      virtual void clearTypeFilter()
      { procNavTypes.clear(); }
 
      virtual void addTypeFilter(NavMessageType nmt)
      { procNavTypes.insert(nmt); }
 
      virtual bool addDataSource(const std::string& source) = 0;
 
      virtual void dump(std::ostream& s, DumpDetail dl) const
      {}
 
      virtual void edit(const CommonTime& fromTime, const CommonTime& toTime)
      {}
 
      virtual void edit(const CommonTime& fromTime, const CommonTime& toTime,
                        const NavSatelliteID& satID)
      {}
 
      virtual void edit(const CommonTime& fromTime, const CommonTime& toTime,
                        const NavSignalID& signal)
      {}
 
      virtual void clear()
      {}
 
      virtual CommonTime getInitialTime() const
      { return CommonTime::END_OF_TIME; }
 
      virtual CommonTime getFinalTime() const
      { return CommonTime::BEGINNING_OF_TIME; }
 
      virtual NavSatelliteIDSet getAvailableSats(const CommonTime& fromTime,
                                                 const CommonTime& toTime)
         const = 0;
 
      virtual NavSatelliteIDSet getAvailableSats(NavMessageType nmt,
                                                 const CommonTime& fromTime,
                                                 const CommonTime& toTime)
         const = 0;
 
      virtual NavMessageIDSet getAvailableMsgs(const CommonTime& fromTime,
                                               const CommonTime& toTime)
         const = 0;
 
      std::set<SatID> getIndexSet(const CommonTime& fromTime,
                                  const CommonTime& toTime) const;
 
      std::set<SatID> getIndexSet(NavMessageType nmt,
                                  const CommonTime& fromTime,
                                  const CommonTime& toTime) const;
 
      virtual bool isPresent(const NavMessageID& nmid,
                             const CommonTime& fromTime,
                             const CommonTime& toTime);
 
      virtual bool isTypePresent(NavMessageType nmt,
                                 const NavSatelliteID& satID,
                                 const CommonTime& fromTime,
                                 const CommonTime& toTime)
      { return isPresent(NavMessageID(satID,nmt),fromTime,toTime); }
 
      virtual std::string getFactoryFormats() const = 0;
 
      virtual void setControl(const FactoryControl& ctrl)
      { factControl = ctrl; }
 
      NavSignalSet supportedSignals;
 
   protected:
      FactoryControl factControl;
 
      NavValidityType navValidity;
 
      NavMessageTypeSet procNavTypes;
   };
 
   typedef std::shared_ptr<NavDataFactory> NavDataFactoryPtr;
   typedef std::multimap<NavSignalID, NavDataFactoryPtr> NavDataFactoryMap;
 
 
}
 
#endif // GNSSTK_NAVDATAFACTORY_HPP