ana::Progress Class Reference

A simple ascii-art progress bar. More...

#include <Progress.h>

Public Member Functions
	Progress (const std::string &title)
	Create and draw the progress bar. More...
	~Progress ()
void	SetProgress (double frac)
	Update the progress fraction between zero and one. More...
void	Done ()
	Call this when action is completed. More...

Protected Member Functions
std::string	FormatTime (double sec) const

Protected Attributes
bool	fDone
	Has Done been called? More...
int	fIFrac
	What character are we on? Prevents unnecessary redraws. More...
time_t	fStart
time_t	fPrevCall
bool	fLive
	Is this bar live (drawable?) More...

Static Protected Attributes
static bool	fAnyLive = false
	Are any bars live? More...

Detailed Description

A simple ascii-art progress bar.

Definition at line 9 of file Progress.h.

Constructor & Destructor Documentation

ana::Progress::Progress

(

const std::string &

title

)

Create and draw the progress bar.

Definition at line 18 of file Progress.cxx.

    : fDone(false), fIFrac(-1), fStart(time(0)), fPrevCall(time(0)), fLive(false)
  {
    // If no else is drawing, we can
    if(!fAnyLive){
      fLive = true;
      fAnyLive = false;
    }

    if(!fLive) return;

    std::cout << title << "..." << std::endl;
    SetProgress(0); // Draw the initial bar
  }

ana::Progress::~Progress

(

)

Definition at line 34 of file Progress.cxx.

  {
    // Finish up in case the user forgot to call Done()
    Done();

    // If we were the ones drawing, we're not anymore
    if(fLive) fAnyLive = false;
  }

Member Function Documentation

void ana::Progress::Done

(

)

Call this when action is completed.

Definition at line 91 of file Progress.cxx.

  {
    if(!fLive) return;

    if(fDone) return; // Can easily be called multiple times

    SetProgress(1); // Make sure the bar shows 100%

    fDone = true;
  }

std::string ana::Progress::FormatTime ( double  sec ) const

protected

Definition at line 103 of file Progress.cxx.

  {
    // Yes, I'm sure there's a standard way to do this, but this was easy, and
    // lets me print exactly what I want.
    std::string ret;
    if(sec >= 60*60-.5){
      ret += TString::Format("%dh", (int(sec+.5)/(60*60))).Data();
    }
    if(sec >= 60-.5){
      ret += TString::Format("%dm", (int(sec+.5)/60)%60).Data();
    }
    if(sec < 60*60){ // don't clutter if still measured in hours
      ret += TString::Format("%ds", (int(sec+.5)%60)).Data();
    }
    return ret;
  }

void ana::Progress::SetProgress

(

double

frac

)

Update the progress fraction between zero and one.

Definition at line 44 of file Progress.cxx.

  {
    if(!fLive || fDone) return;

    // Check if we're outputting to a file. If so don't bother showing off
    // with the progress bar, it won't work.
    struct stat buf;
    fstat(fileno(stdout), &buf);
    const bool isFile = (buf.st_mode & S_IFREG) || (buf.st_mode & S_IFIFO);
    if(isFile) return;

    const int ifrac = (kBarWidth-1)*frac;

    const time_t t_now = time(0);

    // Don't repaint unnecessarily
    if(ifrac == fIFrac && t_now - fPrevCall < 2) return;

    fIFrac = ifrac;
    fPrevCall = time(0);

    std::string str(kBarWidth, ' ');
    for(int i = 0; i < ifrac; ++i) str[i] = '=';
    str[ifrac] = '>';
    str[0] = '[';
    str[kBarWidth-1] = ']';

    if(frac > 0){
      const int elapse = t_now - fStart;
      if(elapse > 2){ // Don't show for very short steps
        if(frac < 1)
          str += " "+FormatTime(elapse*(1-frac)/frac);
        else
          str += " "+FormatTime(elapse);
        str += "    "; // Enough to cover up any previous version
      }
    }

    std::cout << "\r" << str << std::flush;

    if(frac == 1){
      fDone = true;
      std::cout << std::endl;
    }
  }

Member Data Documentation

bool ana::Progress::fAnyLive = false

staticprotected

Are any bars live?

Definition at line 30 of file Progress.h.

bool ana::Progress::fDone

protected

Has Done been called?

Definition at line 22 of file Progress.h.

int ana::Progress::fIFrac

protected

What character are we on? Prevents unnecessary redraws.

Definition at line 23 of file Progress.h.

bool ana::Progress::fLive

protected

Is this bar live (drawable?)

Definition at line 29 of file Progress.h.

time_t ana::Progress::fPrevCall

protected

Definition at line 26 of file Progress.h.

time_t ana::Progress::fStart

protected

Definition at line 25 of file Progress.h.

---

The documentation for this class was generated from the following files:

• Progress.h
• Progress.cxx