GPSEphemerisStore.hpp

Go to the documentation of this file.

#pragma ident "$Id: GPSEphemerisStore.hpp 2741 2011-06-22 16:37:02Z nwu $"

//============================================================================
//
//  This file is part of GPSTk, the GPS Toolkit.
//
//  The GPSTk 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 2.1 of the License, or
//  any later version.
//
//  The GPSTk 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 GPSTk; if not, write to the Free Software Foundation,
//  Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//  Copyright 2004, The University of Texas at Austin
//
//============================================================================
//============================================================================
//
//This software 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 GPSTK_GPSEPHEMERISSTORE_HPP
#define GPSTK_GPSEPHEMERISSTORE_HPP

#include <iostream>
#include <string>
#include <list>
#include <map>

#include "XvtStore.hpp"
#include "SatID.hpp"
#include "EngEphemeris.hpp"
#include "icd_200_constants.hpp"

namespace gpstk
{

   class GPSEphemerisStore : public XvtStore<SatID>
   {
   public:

      GPSEphemerisStore()
         throw()
         : initialTime(DayTime::END_OF_TIME),
           finalTime(DayTime::BEGINNING_OF_TIME),
           method(0)
      {}


      virtual ~GPSEphemerisStore()
      {}


      Xvt getXvt(const SatID sat, const DayTime& t)
         const throw(InvalidRequest);


      void dump(std::ostream& s = std::cout, short detail = 0)
         const throw();


      void edit(const DayTime& tmin,
                const DayTime& tmax = DayTime(DayTime::END_OF_TIME) )
         throw();


      DayTime getInitialTime()
         const throw(InvalidRequest)
      {return initialTime;}


      DayTime getFinalTime()
         const throw(InvalidRequest)
      {return finalTime;}


      bool velocityIsPresent()
         const throw()
      {return true;}


      bool clockIsPresent()
         const throw()
      {return true;}


      //---------------------------------------------------------------
      // Below are interfaces that are unique to this class (i.e. not
      // in the parent class)
      //---------------------------------------------------------------

      short getSatHealth(const SatID sat, const DayTime& t)
         const throw(InvalidRequest);


      bool addEphemeris(const EngEphemeris& eph)
         throw();


      void wiper(const DayTime& t)
         throw()
      {edit(t);}

      void clear()
         throw()
      {edit(DayTime(DayTime::END_OF_TIME));}

      Xvt getXvt(const SatID sat, const DayTime& t, short& ref)
         const throw(InvalidRequest);

      unsigned ubeSize()
         const throw();

      unsigned size()
         const throw()
      { return ubeSize(); };

      const EngEphemeris& findEphemeris(const SatID sat, const DayTime& t)
         const throw(InvalidRequest);

      const EngEphemeris& findUserEphemeris(const SatID sat, const DayTime& t)
         const throw(InvalidRequest);

      const EngEphemeris& findNearEphemeris(const SatID sat, const DayTime& t)
         const throw(InvalidRequest);

      int addToList(std::list<EngEphemeris>& v)
         const throw();

      void SearchNear(void)
         throw()
      {method = 1;}

      void SearchPast(void)
         throw()
      {method = 0;}

      typedef std::map<DayTime, EngEphemeris> EngEphMap;

      const EngEphMap& getEphMap( const SatID sat )
               const throw(InvalidRequest);

   protected:
       void validSatSystem(const SatID sat)
           const throw(InvalidRequest)
       {
           InvalidRequest ire( std::string("Try to get NONE GPS sat position ")
               + std::string("from GPSEphemerisStore, and it's forbidden!") );

           if(sat.system!=SatID::systemGPS) GPSTK_THROW(ire);
       }

   private:

      typedef std::map<short, EngEphMap> UBEMap;

      UBEMap ube;

      DayTime initialTime; //< Time of the first EngEphemeris
      DayTime finalTime;   //< Time of the last EngEphemeris

      int method;

   }; // end class GPSEphemerisStore

} // namespace gpstk
#endif  // GPSTK_GPSEPHEMERISSTORE_HPP

---