bsfm::util::ProgressBar Class Reference

#include <progress_bar.h>

Public Member Functions
	ProgressBar (const std::string &message, double max)
	~ProgressBar ()
std::string	Update (double progress)
void	Reset (double max)
double	GetMax () const
double	GetProgress () const
double	GetPercentage () const
double	GetRemainingSeconds ()

Private Member Functions
double	ElapsedToRemaining (double elapsed) const
std::string	FormatRemaining (double elapsed) const
std::string	ProgressBarString () const
std::string	PrintProgress (double elapsed)

Private Attributes
Timer	timer_
std::string	message_
double	progress_
double	max_
size_t	last_message_length_

Static Private Attributes
static const size_t	bar_length_ = 40

Detailed Description

Definition at line 40 of file progress_bar.h.

Constructor & Destructor Documentation

bsfm::util::ProgressBar::ProgressBar	(	const std::string &	message,
		double	max
	)

Definition at line 43 of file progress_bar.cpp.

    : message_(message), progress_(0), max_(max), last_message_length_(0) {
  timer_.Tic();
}

bsfm::util::ProgressBar::~ProgressBar

(

)

Definition at line 48 of file progress_bar.cpp.

{}

Member Function Documentation

double bsfm::util::ProgressBar::ElapsedToRemaining ( double  elapsed ) const

private

Definition at line 78 of file progress_bar.cpp.

                                                           {
  if (progress_ == 0.0)
    return 0.0;

  return elapsed * (max_ / progress_ - 1.0);
}

std::string bsfm::util::ProgressBar::FormatRemaining ( double  elapsed ) const

private

Definition at line 85 of file progress_bar.cpp.

                                                           {
  // Elapsed is in seconds. Convert to HH:MM:SS.
  int hours = static_cast<int>(elapsed) / 3600;
  int minutes = (static_cast<int>(elapsed) - 3600 * hours) / 60;
  int seconds = static_cast<int>(elapsed) % 60;

  std::stringstream ss;
  ss << std::setfill('0') << std::setw(2) << hours << "h:";
  ss << std::setfill('0') << std::setw(2) << minutes << "m:";
  ss << std::setfill('0') << std::setw(2) << seconds << "s";

  return ss.str();
}

double bsfm::util::ProgressBar::GetMax

(

)

const

Definition at line 62 of file progress_bar.cpp.

                                 {
  return max_;
}

double bsfm::util::ProgressBar::GetPercentage

(

)

const

Definition at line 70 of file progress_bar.cpp.

                                        {
  return progress_ / max_ * 100.;
}

double bsfm::util::ProgressBar::GetProgress

(

)

const

Definition at line 66 of file progress_bar.cpp.

                                      {
  return progress_;
}

double bsfm::util::ProgressBar::GetRemainingSeconds

(

)

Definition at line 74 of file progress_bar.cpp.

                                        {
  return ElapsedToRemaining(timer_.Toc());
}

std::string bsfm::util::ProgressBar::PrintProgress ( double  elapsed )

private

Definition at line 110 of file progress_bar.cpp.

                                                   {
  double remaining = ElapsedToRemaining(elapsed);
  std::string remaining_string = FormatRemaining(remaining);

  std::stringstream ss;
  ss << "   " << message_ << ": " << progress_ << "/" << max_ << " ("
     << std::fixed << std::setprecision(2) << GetPercentage()
     << "%%), remaining: " << remaining_string << ".";

  std::string progress_bar = ProgressBarString();

  size_t num_backspaces = bar_length_ + last_message_length_;
  printf("%s", std::string(num_backspaces, '\b').c_str());

  printf("%s", progress_bar.c_str());
  printf("%s", ss.str().c_str());

  last_message_length_ = ss.str().length();

  return ss.str();
}

std::string bsfm::util::ProgressBar::ProgressBarString ( ) const

private

Definition at line 99 of file progress_bar.cpp.

                                               {
  std::stringstream progress_bar;
  std::string equals(floor((bar_length_ - 3) * progress_ / max_), '=');
  progress_bar << "[" << equals << ">";

  std::string remainder(bar_length_ - 3 - equals.length(), ' ');
  progress_bar << remainder << "]";

  return progress_bar.str();
}

void bsfm::util::ProgressBar::Reset

(

double

max

)

Definition at line 56 of file progress_bar.cpp.

                                  {
  max_ = max;
  progress_ = 0;
  timer_.Tic();
}

std::string bsfm::util::ProgressBar::Update

(

double

progress

)

Definition at line 50 of file progress_bar.cpp.

                                             {
  progress_ = progress;
  double elapsed = timer_.Toc();
  return PrintProgress(elapsed);
}

Member Data Documentation

const size_t bsfm::util::ProgressBar::bar_length_ = 40

staticprivate

Definition at line 79 of file progress_bar.h.

size_t bsfm::util::ProgressBar::last_message_length_

private

Definition at line 78 of file progress_bar.h.

double bsfm::util::ProgressBar::max_

private

Definition at line 76 of file progress_bar.h.

std::string bsfm::util::ProgressBar::message_

private

Definition at line 73 of file progress_bar.h.

double bsfm::util::ProgressBar::progress_

private

Definition at line 75 of file progress_bar.h.

Timer bsfm::util::ProgressBar::timer_

private

Definition at line 72 of file progress_bar.h.

---

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

• /Users/eanelson/Git/berkeley_sfm/src/cpp/util/progress_bar.h
• /Users/eanelson/Git/berkeley_sfm/src/cpp/util/progress_bar.cpp