NavLibrary.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_NAVLIBRARY_HPP
#define GNSSTK_NAVLIBRARY_HPP
 
#include "NavDataFactory.hpp"
#include "Xvt.hpp"
#include "SVHealth.hpp"
#include "Position.hpp"
 
namespace gnsstk
{
 
 
   class NavLibrary
   {
   public:
      bool getXvt(const NavSatelliteID& sat, const CommonTime& when,
                  Xvt& xvt, bool useAlm, SVHealth xmitHealth = SVHealth::Any,
                  NavValidityType valid = NavValidityType::ValidOnly,
                  NavSearchOrder order = NavSearchOrder::User);
 
      bool getXvt(const NavSatelliteID& sat, const CommonTime& when,
                  Xvt& xvt, bool useAlm, const ObsID& oid,
                  SVHealth xmitHealth = SVHealth::Any,
                  NavValidityType valid = NavValidityType::ValidOnly,
                  NavSearchOrder order = NavSearchOrder::User);
 
      bool getXvt(const NavSatelliteID& sat, const CommonTime& when,
                  Xvt& xvt, SVHealth xmitHealth = SVHealth::Any,
                  NavValidityType valid = NavValidityType::ValidOnly,
                  NavSearchOrder order = NavSearchOrder::User);
 
      bool getXvt(const NavSatelliteID& sat, const CommonTime& when,
                  Xvt& xvt, const ObsID& oid,
                  SVHealth xmitHealth = SVHealth::Any,
                  NavValidityType valid = NavValidityType::ValidOnly,
                  NavSearchOrder order = NavSearchOrder::User);
 
      bool getHealth(const NavSatelliteID& sat, const CommonTime& when,
                     SVHealth& healthOut, SVHealth xmitHealth = SVHealth::Any,
                     NavValidityType valid = NavValidityType::ValidOnly,
                     NavSearchOrder order = NavSearchOrder::User);
 
      bool getOffset(TimeSystem fromSys, TimeSystem toSys,
                     const CommonTime& when, NavDataPtr& navOut,
                     SVHealth xmitHealth = SVHealth::Any,
                     NavValidityType valid = NavValidityType::ValidOnly);
 
      bool getOffset(TimeSystem fromSys, TimeSystem toSys,
                     const CommonTime& when, double& offset,
                     SVHealth xmitHealth = SVHealth::Any,
                     NavValidityType valid = NavValidityType::ValidOnly);
 
      bool getIonoCorr(SatelliteSystem sys, const CommonTime& when,
                       const Position& rxgeo, const Position& svgeo,
                       CarrierBand band, double& corrOut,
                       NavType nt = NavType::Any);
 
      bool getIonoCorr(const SatID& sat, const CommonTime& when,
                       const Position& rxgeo,
                       CarrierBand band, double& corrOut,
                       NavType nt = NavType::Any, int freqOffs = 0,
                       bool freqOffsWild = true);
 
      bool getISC(const SatID& sat, const ObsID& oid, const CommonTime& when,
                  double& corrOut, SVHealth xmitHealth = SVHealth::Any,
                  NavValidityType valid = NavValidityType::ValidOnly,
                  NavSearchOrder order = NavSearchOrder::User);
 
      static std::list<NavMessageID> getISCNMID(const SatID& sat,
                                                const ObsID& oid);
 
      bool find(const NavMessageID& nmid, const CommonTime& when,
                NavDataPtr& navOut, SVHealth xmitHealth, NavValidityType valid,
                NavSearchOrder order);
 
      void setValidityFilter(NavValidityType nvt);
 
      void setTypeFilter(const NavMessageTypeSet& nmts);
 
      void clearTypeFilter();
 
      void addTypeFilter(NavMessageType nmt);
 
      void addFactory(NavDataFactoryPtr& fact);
 
      void dump(std::ostream& s, DumpDetail dl) const;
 
      void edit(const CommonTime& fromTime, const CommonTime& toTime);
 
      void edit(const CommonTime& fromTime, const CommonTime& toTime,
                const NavSatelliteID& satID);
 
      void edit(const CommonTime& fromTime, const CommonTime& toTime,
                const NavSignalID& signal);
 
      void clear();
 
      CommonTime getInitialTime() const;
 
      CommonTime getFinalTime() const;
 
      NavSatelliteIDSet getAvailableSats(const CommonTime& fromTime,
                                         const CommonTime& toTime) const;
 
      NavSatelliteIDSet getAvailableSats(NavMessageType nmt,
                                         const CommonTime& fromTime,
                                         const CommonTime& toTime) const;
 
      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;
 
      bool isPresent(const NavMessageID& nmid,
                     const CommonTime& fromTime,
                     const CommonTime& toTime);
 
      bool isTypePresent(NavMessageType nmt,
                         const NavSatelliteID& satID,
                         const CommonTime& fromTime,
                         const CommonTime& toTime)
      { return isPresent(NavMessageID(satID,nmt),fromTime,toTime); }
 
      std::string getFactoryFormats() const;
 
   protected:
      NavDataFactoryMap factories;
   };
 
 
}
 
#endif // GNSSTK_NAVLIBRARY_HPP