DataIOBase.hpp

Go to the documentation of this file.

/* 
 * DataIOBase.hpp 
 *
 * This file is part of the Chemical Data Processing Toolkit
 *
 * Copyright (C) 2003 Thomas Seidel <thomas.seidel@univie.ac.at>
 *
 * This library 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 of the License, or (at your option) any later version.
 *
 * This library 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 this library; see the file COPYING. If not, write to
 * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */
 
#ifndef CDPL_BASE_DATAIOBASE_HPP
#define CDPL_BASE_DATAIOBASE_HPP
 
#include <vector>
#include <utility>
#include <cstddef>
#include <functional>
 
#include "CDPL/Base/APIPrefix.hpp"
#include "CDPL/Base/ControlParameterContainer.hpp"
 
 
namespace CDPL
{
 
    namespace Base
    {
 
        class CDPL_BASE_API DataIOBase : public ControlParameterContainer
        {
 
          public:
            typedef std::function<void(const DataIOBase&, double)> IOCallbackFunction;
 
            std::size_t registerIOCallback(const IOCallbackFunction& func);
 
            void unregisterIOCallback(std::size_t id);
 
            void invokeIOCallbacks(double progress) const;
 
            void clearIOCallbacks();
 
          protected:
            DataIOBase() {}
 
            DataIOBase(const DataIOBase& io_base):
                ControlParameterContainer(io_base) {}
 
            ~DataIOBase() {}
 
            DataIOBase& operator=(const DataIOBase& io_base);
 
          private:
            typedef std::pair<std::size_t, IOCallbackFunction> CallbackListEntry;
            typedef std::vector<CallbackListEntry>             CallbackList;
 
            CallbackList callbacks;
        };
    } // namespace Base
} // namespace CDPL
 
#endif // CDPL_BASE_DATAIOBASE_HPP