ProgressBar.hpp

/* Copyright (c) 2013 David Sichau <mail"at"sichau"dot"eu>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 */

#ifndef UTILIB_PROGRESSBAR_HPP_
#define UTILIB_PROGRESSBAR_HPP_

#include <UtilLib/include/Timer.hpp>
#include <iostream>

namespace UtilLib {
class ProgressBar {
 public:
    explicit ProgressBar(
            unsigned int expected_count,
            double updateInterval = 30,
            std::ostream& os = std::cout);
    unsigned int operator+=(unsigned int increment);

    unsigned int operator++();

    unsigned int operator++(int i);

 private:
    unsigned int count_;  
    unsigned int expectedCount_;  
    unsigned int nextTicCount_;  
    unsigned int updateCount_;  
    unsigned int tic_;  

    std::ostream& outputStream_;
    const float updateInterval_;


    void displayTic();

    void displayPercentage();

    Timer wholeTime_;
};
} /* end namespace  */
#endif /* UTILIB_PROGRESSBAR_HPP_ */