ossimFileWalker.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
//
// File: ossimFileWalker.h
// 
// License:  MIT
// 
// See LICENSE.txt file in the top level directory for more details.
//
// Author:  David Burken
//
// Description:  See description for class below.
// 
//----------------------------------------------------------------------------
// $Id$

#ifndef ossimFileWalker_HEADER
#define ossimFileWalker_HEADER 1

#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimFilename.h>
#include <ossim/parallel/ossimJob.h>
#include <ossim/parallel/ossimJobMultiThreadQueue.h>
#include <string>
#include <vector>
#include <mutex>
#include <memory>

class ossimFilename;
class ossimFileProcessorInterface;

class OSSIM_DLL ossimFileWalker
{
public:
   
   ossimFileWalker();

   ~ossimFileWalker();

   void walk(const std::vector<ossimFilename>& files);

   void walk(const ossimFilename& root);

   void setFileProcessor(ossimFileProcessorInterface* fpi);

   const std::vector<std::string>& getFilteredExtensions() const;

   std::vector<std::string>& getFilteredExtensions();

   void dumpFilteredExtensionList() const;

   void initializeDefaultFilterList();

   void setRecurseFlag(bool flag);

   void setWaitOnDirFlag(bool flag);

   void setAbortFlag(bool flag);

   void setNumberOfThreads(ossim_uint32 nThreads);
   
private:

   class ossimFileWalkerJob : public ossimJob
   {
   public:
      ossimFileWalkerJob(ossimFileProcessorInterface* fpi,
                         const ossimFilename& file);

protected:
      virtual void run();
      
   private:
      ossimFileProcessorInterface* m_fileProcessor;
      ossimFilename                m_file;
      
   }; // End: class ossimFileWalkerJob

   class ossimFileWalkerJobCallback : public ossimJobCallback
   {
   public:
      ossimFileWalkerJobCallback();
      virtual void started(std::shared_ptr<ossimJob> job);
      virtual void finished(std::shared_ptr<ossimJob> job);
      virtual void canceled(std::shared_ptr<ossimJob> job);
   };

   void walkDir(const ossimFilename& dir);
   
   bool isFiltered(const ossimFilename& f) const;
   
   bool isDotFile(const ossimFilename& f) const;
   
   ossimFileProcessorInterface*          m_fileProcessor;
   std::shared_ptr<ossimJobMultiThreadQueue> m_jobQueue;
   std::vector<std::string>              m_filteredExtensions;
   bool                                  m_recurseFlag;
   bool                                  m_waitOnDirFlag;
   bool                                  m_abortFlag;
   std::mutex                            m_mutex;
};

#endif /* #ifndef ossimFileWalker_HEADER */