MSCStore.hpp

Go to the documentation of this file.

#pragma ident "$Id: MSCStore.hpp 2223 2010-01-11 16:27:48Z afarris $"

//============================================================================
//
//  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 2007, 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_MSCSTORE_HPP
#define GPSTK_MSCSTORE_HPP

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

#include "FileStore.hpp"
#include "XvtStore.hpp"
#include "MSCData.hpp"
#include "MSCStream.hpp"
#include "MSCHeader.hpp"

namespace gpstk
{
   
   class MSCStore : public XvtStore<std::string>,
                    public FileStore<gpstk::MSCHeader>
   {
   public:

      MSCStore()
         throw()
         : initialTime(DayTime::END_OF_TIME), 
           finalTime(DayTime::END_OF_TIME)
      {}

      virtual ~MSCStore()
      {}

      Xvt getXvt(const std::string stationID, const DayTime& t)
         const throw(InvalidRequest);


      Xvt getXvt(unsigned long stationIDno, const DayTime& t)
         const throw(InvalidRequest);


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


      void edit(const DayTime& tmin = DayTime(DayTime::BEGINNING_OF_TIME), 
                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 false;}

      //---------------------------------------------------------------
      // FileStore interfaces
      //---------------------------------------------------------------
      void loadFile(const std::string& filename) 
         throw(FileMissingException);    

      //---------------------------------------------------------------
      // Below are interfaces that are unique to this class (i.e. not 
      // in the parent class)
      //---------------------------------------------------------------
      bool addMSC(const MSCData& msc)
         throw();
      
      void clear()
         throw()
      {edit(gpstk::DayTime(gpstk::DayTime::BEGINNING_OF_TIME), 
            gpstk::DayTime(gpstk::DayTime::BEGINNING_OF_TIME));}
      
      unsigned size()
         const throw();
      
      const MSCData& findMSC(const std::string stationID, const DayTime& t)
         const throw(InvalidRequest);
      const MSCData& findMSC(const unsigned long stationID, const DayTime& t) 
         const throw(InvalidRequest);

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

      // Return a list of the station IDs for all MSCData objects
      // currently stored. 
      std::list<std::string> getIDList();
         
   private:
      typedef std::map<gpstk::DayTime, MSCData> StaMSCMap;
      typedef StaMSCMap::const_iterator SMMci;
      typedef StaMSCMap::iterator SMMi;
      
      typedef std::map<std::string, StaMSCMap> MSCMap;
      typedef MSCMap::const_iterator MMci;
      typedef MSCMap::iterator MMi;
      
      MSCMap mscMap;
      
      DayTime initialTime; //< Time of the first MSCData object
      DayTime finalTime;   //< Time of the last MSCData object
                           //< (N.B.: finalTime is irrelevant in the 
                           //<  current implementation as there is no
                           //<  "end of effectivity" for an MSCData object.
      
      static const double SEC_YEAR;
   }; // end class MSCStore
   
} // namespace gpstk
#endif  // GPSTK_MSCSTORE_HPP

---