FileFilterFrame.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_FILEFILTERFRAME_HPP
#define GNSSTK_FILEFILTERFRAME_HPP
 
#include "FileSpec.hpp"
#include "FileFilter.hpp"
#include "FileSpecFind.hpp"
#include "FileUtils.hpp"
 
namespace gnsstk
{
 
 
   template <class FileStream, class FileData>
   class FileFilterFrame : public FileFilter<FileData>
   {
   public:
      FileFilterFrame(const gnsstk::CommonTime& start =
                      gnsstk::CommonTime::BEGINNING_OF_TIME,
                      const gnsstk::CommonTime& end =
                      gnsstk::CommonTime::END_OF_TIME);
 
      FileFilterFrame(const std::vector<std::string>& fileList,
                      const gnsstk::CommonTime& start =
                      gnsstk::CommonTime::BEGINNING_OF_TIME,
                      const gnsstk::CommonTime& end =
                      gnsstk::CommonTime::END_OF_TIME);
 
      FileFilterFrame(const std::string& filename,
                      const gnsstk::CommonTime& start =
                      gnsstk::CommonTime::BEGINNING_OF_TIME,
                      const gnsstk::CommonTime& end =
                      gnsstk::CommonTime::END_OF_TIME);
 
      FileFilterFrame(const FileSpec& spec,
                      const gnsstk::CommonTime& start =
                      gnsstk::CommonTime::BEGINNING_OF_TIME,
                      const gnsstk::CommonTime& end =
                      gnsstk::CommonTime::END_OF_TIME,
                      const FileSpecFind::Filter& filter =
                      FileSpecFind::Filter());
 
      FileFilterFrame&
      newSource(const FileSpec& filespec,
                const gnsstk::CommonTime& start =
                gnsstk::CommonTime::BEGINNING_OF_TIME,
                const gnsstk::CommonTime& end =
                gnsstk::CommonTime::END_OF_TIME,
                const FileSpecFind::Filter& filter =
                FileSpecFind::Filter());
 
      FileFilterFrame&
      newSource(const std::string& filename,
                const gnsstk::CommonTime& start =
                gnsstk::CommonTime::BEGINNING_OF_TIME,
                const gnsstk::CommonTime& end =
                gnsstk::CommonTime::END_OF_TIME);
 
      FileFilterFrame&
      newSource(const std::vector<std::string>& fileList,
                const gnsstk::CommonTime& start =
                gnsstk::CommonTime::BEGINNING_OF_TIME,
                const gnsstk::CommonTime& end =
                gnsstk::CommonTime::END_OF_TIME);
 
      virtual ~FileFilterFrame() {}
 
      bool writeFile(const std::string& outputFile,
                     const bool append = false) const;
 
      bool writeFile(FileStream& stream) const;
 
   protected:
      void init(const FileSpecFind::Filter& filter = FileSpecFind::Filter());
 
 
   protected:
      FileSpec fs;
      gnsstk::CommonTime startTime, endTime;
 
   };
 
 
   template <class FileStream, class FileData>
   FileFilterFrame<FileStream,FileData> ::
   FileFilterFrame(const gnsstk::CommonTime& start,
                   const gnsstk::CommonTime& end)
         : startTime(start), endTime(end)
   {}
 
   template <class FileStream, class FileData>
   FileFilterFrame<FileStream,FileData> ::
   FileFilterFrame(const std::vector<std::string>& fileList,
                   const gnsstk::CommonTime& start,
                   const gnsstk::CommonTime& end)
         : startTime(start), endTime(end)
   {
      typename std::vector<std::string>::const_iterator itr;
      for (itr = fileList.begin(); itr != fileList.end(); itr++)
      {
         fs.newSpec(*itr);
         init();
      }
   }
 
   template <class FileStream, class FileData>
   FileFilterFrame<FileStream,FileData> ::
   FileFilterFrame(const std::string& filename,
                   const gnsstk::CommonTime& start,
                   const gnsstk::CommonTime& end)
         : fs(filename), startTime(start), endTime(end)
   {
      init();
   }
 
   template <class FileStream, class FileData>
   FileFilterFrame<FileStream,FileData> ::
   FileFilterFrame(const FileSpec& spec,
                   const gnsstk::CommonTime& start,
                   const gnsstk::CommonTime& end,
                   const FileSpecFind::Filter& filter)
         : fs(spec), startTime(start), endTime(end)
   {
      init(filter);
   }
 
   template <class FileStream, class FileData>
   FileFilterFrame<FileStream, FileData>&
   FileFilterFrame<FileStream,FileData> ::
   newSource(const FileSpec& filespec,
             const gnsstk::CommonTime& start,
             const gnsstk::CommonTime& end,
             const FileSpecFind::Filter& filter)
   {
      startTime = start;
      endTime = end;
 
      fs = filespec;
      init(filter);
      return *this;
   }
 
   template <class FileStream, class FileData>
   FileFilterFrame<FileStream, FileData>&
   FileFilterFrame<FileStream,FileData> ::
   newSource(const std::string& filename,
             const gnsstk::CommonTime& start,
             const gnsstk::CommonTime& end)
   {
      startTime = start;
      endTime = end;
 
      fs.newSpec(filename);
      init();
      return *this;
   }
 
   template <class FileStream, class FileData>
   FileFilterFrame<FileStream, FileData>&
   FileFilterFrame<FileStream,FileData> ::
   newSource(const std::vector<std::string>& fileList,
             const gnsstk::CommonTime& start,
             const gnsstk::CommonTime& end)
   {
      startTime = start;
      endTime = end;
 
      typename std::vector<std::string>::const_iterator itr;
      for (itr = fileList.begin(); itr != fileList.end(); itr++)
      {
         fs.newSpec(*itr);
         init();
      }
      return *this;
   }
 
   template <class FileStream, class FileData>
   void
   FileFilterFrame<FileStream,FileData> ::
   init(const FileSpecFind::Filter& filter)
   {
         // find the files
      std::list<std::string> listOfFiles =
         FileSpecFind::find(fs, startTime, endTime, filter);
 
         // for each file, read it into the filter
      for (const auto& i : listOfFiles)
      {
         FileStream s(i.c_str());
 
         if (s.good())
         {
            FileData data;
            while (s >> data)
               this->addData(data);
         }
      }
   }
 
   template <class FileStream, class FileData>
   bool FileFilterFrame<FileStream,FileData> ::
   writeFile(const std::string& str,
             const bool append) const
   {
      if (!this->dataVec.empty())
      {
            // make the directory (if needed)
         std::string::size_type pos = str.rfind('/');
         if (pos != std::string::npos)
            gnsstk::FileUtils::makeDir(str.substr(0,pos).c_str(), 0755);
 
         std::ios::openmode mode = std::ios::out;
         if (append)
            mode |= (std::ios::app|std::ios::ate);
 
         FileStream stream(str.c_str(), mode);
         return writeFile(stream);
      }
 
      return true;
   }
 
   template <class FileStream, class FileData>
   bool FileFilterFrame<FileStream,FileData> ::
   writeFile(FileStream& stream) const
   {
      if (!this->dataVec.empty())
      {
         stream.exceptions(std::ios::failbit);
 
         typename std::list<FileData>::const_iterator index;
         for(index = this->dataVec.begin(); index != this->dataVec.end(); index++)
            (*index).putRecord(stream);
      }
 
      return true;
   }
 
}  // namespace gnsstk
 
#endif // GNSSTK_FILEFILTERFRAME_HPP