/scr/tee1/isis/lib/Core/CoreUtils/progressfeedback.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2010  reimer@cbs.mpg.de

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef PROGRESSFEEDBACK_HPP
#define PROGRESSFEEDBACK_HPP
#include <stddef.h>
#include <string>
#include <boost/progress.hpp>
#include <boost/scoped_ptr.hpp>

namespace isis
{
namespace util
{
/*
 * Basic class for any feedback given from longlasting processes about its progress (e.g. file loading)
 */
class ProgressFeedback: boost::noncopyable // ProgressFeedback should not be copyable - would break the progress counting
{
public:
    virtual void show( size_t max, std::string header = "" ) = 0;
    virtual size_t progress( const std::string message = "", size_t step = 1 ) = 0;
    virtual void close() = 0;
    virtual size_t getMax() = 0;
    virtual size_t extend( size_t by ) = 0;
    ProgressFeedback &operator++();
    virtual ~ProgressFeedback();
};

/*
 * Most simple implementation of a progress bar on the console
 */
class ConsoleFeedback: public ProgressFeedback
{
    boost::scoped_ptr<boost::progress_display> disp;
public:
    void close();
    size_t getMax();
    size_t progress( const std::string message = "", size_t step = 1 );
    void show( size_t max, std::string header );
    size_t extend( size_t by );
};
}
}
#endif // PROGRESSFEEDBACK_HPP