FileHunter.hpp

Go to the documentation of this file.

#pragma ident "$Id: FileHunter.hpp 70 2006-08-01 18:36:21Z ehagen $"



#ifndef GPSTK_FILEHUNTER_HPP
#define GPSTK_FILEHUNTER_HPP

//============================================================================
//
//  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.
//
//=============================================================================






#include "FileSpec.hpp"

namespace gpstk
{

   NEW_EXCEPTION_CLASS(FileHunterException, gpstk::Exception);

   class FileHunter
   {
   public:

      enum FileChunking
      {
         WEEK,
         DAY,
         HOUR,
         MINUTE
      };
      
      typedef std::pair<FileSpec::FileSpecType, std::vector<std::string> >
         FilterPair;

      FileHunter(const std::string& filespec)
         throw(FileHunterException);

      FileHunter(const FileSpec& filespec)
         throw(FileHunterException);

      FileHunter& newHunt(const std::string& filespec)
         throw(FileHunterException);

      FileHunter& newHunt(const FileSpec& filespec)
         throw(FileHunterException)
         {return newHunt(filespec.getSpecString());}

      FileHunter& setFilter(const FileSpec::FileSpecType fst,
                                    const std::vector<std::string>& filter)
         throw(FileHunterException);

      std::vector<std::string> 
      find(const gpstk::DayTime& start = gpstk::DayTime::BEGINNING_OF_TIME,
           const gpstk::DayTime& end = gpstk::DayTime::END_OF_TIME,
           const FileSpec::FileSpecSortType fsst = FileSpec::ascending,
           enum FileChunking chunk = DAY) const
         throw(FileHunterException);

      void dump(std::ostream& o) const;

   private:
         // disallow these
      FileHunter();
      FileHunter(const FileHunter& fh);
      FileHunter& operator=(const FileHunter& fh);

   protected:
      void init(const std::string& filespec)
         throw(FileHunterException);

      std::vector<std::string> 
      searchHelper(const std::string& directory,
                   const FileSpec& fs) const
         throw(FileHunterException);

      void filterHelper(std::vector<std::string>& fileList, 
                        const FileSpec& fs) const
         throw(FileHunterException);

      std::vector<FileSpec> fileSpecList;

      std::vector<FilterPair> filterList;
   }; // FileHunter


} // namespace




#endif

---