FileGrabber.h

Go to the documentation of this file.

/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLIO/src/ICLIO/FileGrabber.h                          **
** Module : ICLIO                                                  **
** Authors: Christof Elbrechter, Viktor Richter                    **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/

#pragma once

#include <ICLUtils/CompatMacros.h>
#include <ICLIO/Grabber.h>
#include <ICLIO/FileGrabberPlugin.h>

namespace icl{
  namespace io{


    class ICLIO_API FileGrabber : public Grabber {
      public:

        friend class FileGrabberPluginMapInitializer;

        FileGrabber();


        FileGrabber(const std::string &pattern, bool buffer=false, bool ignoreDesiredParams=false)
        throw(utils::FileNotFoundException);

        virtual ~FileGrabber();

        virtual const core::ImgBase *acquireImage();

        unsigned int getFileCount() const;

        const std::string &getNextFileName() const;


        void bufferImages(bool omitExceptions=true);


        void next();


        void prev();



        void forcePluginType(const std::string &suffix);

      private:
        const core::ImgBase *grabImage();
        void addProperties();
        void processPropertyChange(const utils::Configurable::Property &p);
        void updateProperties(const core::ImgBase* img);

        struct Data;
        Data *m_data;
        utils::Mutex m_propertyMutex;
        bool m_updatingProperties;
    };
    
  } // namespace io
}