SimpleProgressBar Class Reference

Simple Progress Bar. More...

#include <ored/utilities/progressbar.hpp>

Inheritance diagram for SimpleProgressBar:

Collaboration diagram for SimpleProgressBar:

Public Member Functions
	SimpleProgressBar (const std::string &message, const QuantLib::Size messageWidth=40, const QuantLib::Size barWidth=40, const QuantLib::Size numberOfScreenUpdates=100)
void	updateProgress (const unsigned long progress, const unsigned long total, const std::string &detail) override
	ProgressIndicator interface. More...
void	reset () override
Public Member Functions inherited from ProgressIndicator
	ProgressIndicator ()
virtual	~ProgressIndicator ()
virtual void	updateProgress (const unsigned long progress, const unsigned long total, const std::string &detail)=0
virtual void	reset ()=0

Private Attributes
std::string	key_
unsigned int	messageWidth_
unsigned int	barWidth_
unsigned int	numberOfScreenUpdates_
unsigned int	updateCounter_
bool	finalized_

Detailed Description

Simple Progress Bar.

Simple Progress Bar that writes a message followed by a status bar to std::cout, no other output should be written to std::cout during the bar from this instance is displayed

Definition at line 85 of file progressbar.hpp.

Constructor & Destructor Documentation

SimpleProgressBar()

SimpleProgressBar	(	const std::string &	message,
		const QuantLib::Size	messageWidth = 40,
		const QuantLib::Size	barWidth = 40,
		const QuantLib::Size	numberOfScreenUpdates = 100
	)

Definition at line 47 of file progressbar.cpp.

    : key_(message), messageWidth_(messageWidth), barWidth_(barWidth),
      numberOfScreenUpdates_(numberOfScreenUpdates), updateCounter_(0), finalized_(false) {
    updateProgress(0, 1, "");
    updateCounter_--;
}

Here is the call graph for this function:

Member Function Documentation

updateProgress()

void updateProgress ( const unsigned long  progress, const unsigned long  total, const std::string &  detail  )

overridevirtual

ProgressIndicator interface.

Implements ProgressIndicator.

Definition at line 55 of file progressbar.cpp.

                                                                                                                       {
    if (!ConsoleLog::instance().enabled())
        return; 
    if (finalized_)
        return;
    double ratio = static_cast<double>(progress) / static_cast<double>(total);
    if (progress >= total) {
        std::cout << "\r" << std::setw(messageWidth_) << std::left << key_;
        for (unsigned int i = 0; i < barWidth_; ++i)
            std::cout << " ";
        std::cout << "       \r";
        std::cout << std::setw(messageWidth_) << std::left << key_;
        std::cout.flush();
        finalized_ = true;
        return;
    }
    if (updateCounter_ > 0 && progress * numberOfScreenUpdates_ < updateCounter_ * total) {
        return;
    }
    std::cout << "\r" << std::setw(messageWidth_) << std::left << key_;
    if (barWidth_ > 0)
        std::cout << "[";
    unsigned int pos = static_cast<unsigned int>(static_cast<double>(barWidth_) * ratio);
    for (unsigned int i = 0; i < barWidth_; ++i) {
        if (i < pos)
            std::cout << "=";
        else if (i == pos && pos != 0)
            std::cout << ">";
        else
            std::cout << " ";
    }
    if (barWidth_ > 0)
        std::cout << "] ";
    std::cout << static_cast<int>(ratio * 100.0) << " %\r";
    std::cout.flush();
    updateCounter_++;
}

Here is the caller graph for this function:

reset()

void reset ( )

overridevirtual

Implements ProgressIndicator.

Definition at line 93 of file progressbar.cpp.

                              {
    updateCounter_ = 0;
    finalized_ = false;
}

Member Data Documentation

key_

std::string key_

private

Definition at line 95 of file progressbar.hpp.

messageWidth_

unsigned int messageWidth_

private

Definition at line 96 of file progressbar.hpp.

barWidth_

unsigned int barWidth_

private

Definition at line 96 of file progressbar.hpp.

numberOfScreenUpdates_

unsigned int numberOfScreenUpdates_

private

Definition at line 96 of file progressbar.hpp.

updateCounter_

unsigned int updateCounter_

private

Definition at line 96 of file progressbar.hpp.

finalized_

bool finalized_

private

Definition at line 97 of file progressbar.hpp.