FileStore.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_FILE_STORE_INCLUDE
#define GNSSTK_FILE_STORE_INCLUDE
 
#include <vector>
#include <map>
#include <iostream>
#include <iomanip>
#include "Exception.hpp"
 
namespace gnsstk
{
 
 
   template <class HeaderType> class FileStore
   {
   private:
 
      std::map<std::string, HeaderType> headerMap;
 
   public:
 
      FileStore() noexcept {};
 
      ~FileStore() {};
 
      std::vector<std::string> getFileNames() const
      {
         std::vector<std::string> names;
         typename std::map<std::string, HeaderType>::const_iterator fit;
         for(fit=headerMap.begin(); fit != headerMap.end(); fit++)
            names.push_back(fit->first);
         return names;
      }
 
      void addFile(const std::string& fn, HeaderType& header)
      {
         if(headerMap.find(fn) != headerMap.end()) {
            dump(std::cout, 1);
            InvalidRequest e("Duplicate file name");
            GNSSTK_THROW(e);
         }
         headerMap.insert(make_pair(fn,header));
      }
 
      const HeaderType& getHeader(const std::string& fn) const
      {
         typename std::map<std::string, HeaderType>::const_iterator iter_fn = headerMap.find(fn);
         if( iter_fn == headerMap.end())
         {
            InvalidRequest e("File name not found");
            GNSSTK_THROW(e);
         }
         return iter_fn->second;
            // changed from headerMap[fn] since that is a non-const
            // member of std::map and therefore could modify
            // headerMap, making this function not be side-effect free
      }
 
      void dump(std::ostream& os = std::cout, short detail = 0)
         const noexcept
      {
         int n(0);
         os << "Dump of FileStore\n";
         typename std::map<std::string, HeaderType>::const_iterator fit;
         for(fit=headerMap.begin(); fit != headerMap.end(); fit++) {
            os << " File " << std::setw(2) << ++n << ": " << fit->first;
            if(detail >= 1) {
               os << " (header for this file follows)\n";
               (fit->second).dump(os);
            }
            else os << std::endl;
         }
         os << "End dump of FileStore\n";
      }
 
      void clear()
         noexcept
      {
         headerMap.clear();
      }
 
 
      unsigned size() const noexcept { return headerMap.size(); }
 
      unsigned nfiles() const noexcept { return size(); }
 
   }; // end class FileStore
 
 
}  // namespace
 
#endif // GNSSTK_FILE_STORE_INCLUDE