textProgressBar.h

Go to the documentation of this file.

#pragma once
 
#include "textProgressBarConventions.h"
 
// c++
#include <string>
using std::string;
 
class TextProgressBar
{
public:
    TextProgressBar(int  w, string t, int minimum = 0, int maximum = 100, char s = '[', char e = ']', char m = '=',
                    char a                        = '>') :
        barWidth(w), title(t), min(minimum), max(maximum), startBarChar(s), endBarChar(e), middleBarChar(m),
        advanceBarChar(a) {
        // Determine the internal update granularity so we print at most TEXTPROGRESSBARNSTEPS updates.
        // If the range is too small, "singleStep" becomes 0 and updates will be suppressed.
        if (maximum - minimum > TEXTPROGRESSBARNSTEPS) {
            singleStep = (maximum - minimum) / TEXTPROGRESSBARNSTEPS;
        }
        else {
            singleStep = 0;
        }
 
        // The next progress threshold at which we will print an update.
        indexStep = minimum;
    }
 
    void setProgress(int p);
 
private:
    int barWidth;
 
    string title;
 
    int min, max;
 
    char startBarChar, endBarChar;
 
    char middleBarChar, advanceBarChar;
 
    int singleStep;
 
    int indexStep;
};