Rosetta Protocols  2014.35
Public Member Functions | Private Attributes | List of all members
protocols::loop_modeling::loggers::ProgressBar Class Reference

Display a progress bar that updates after each iteration. More...

#include <ProgressBar.hh>

Public Member Functions

 ProgressBar (string label="")
 Constructor with optional label argument. More...
 
void log_iteration_ (Pose const &pose)
 Update the progress bar. More...
 
- Public Member Functions inherited from protocols::loop_modeling::loggers::Logger
void log_beginning (Pose const &pose, Size I, Size J, Size K)
 Record the beginning of a simulation. More...
 
void log_beginning (Pose const &pose, utility::vector1< Size > iterations)
 Record the beginning of a simulation. More...
 
void log_iteration (Pose const &pose, Size i, Size j, Size k)
 Record the start of another iteration. More...
 
void log_monte_carlo (protocols::moves::MonteCarlo const &monte_carlo)
 Record the result of a MonteCarlo acceptance check. More...
 
void log_monte_carlo (protocols::moves::MonteCarloCOP monte_carlo)
 Record the result of a MonteCarlo acceptance check. More...
 
void log_ending (Pose const &pose)
 Record the end of a simulation. More...
 

Private Attributes

string label_
 

Additional Inherited Members

- Protected Member Functions inherited from protocols::loop_modeling::loggers::Logger
virtual void log_beginning_ (Pose const &)
 Reimplemented by subclasses to record the beginning of a simulation. More...
 
virtual void log_monte_carlo_ (protocols::moves::MonteCarlo const &)
 Reimplemented by subclasses to record the result of a MonteCarlo acceptance check. More...
 
virtual void log_ending_ (Pose const &)
 Reimplemented by subclasses to record the end of a simulation. More...
 
Size get_iteration_as_int () const
 Return the current iteration as an integer. More...
 
Size get_max_iteration_as_int () const
 Return the number of iterations that will be run in the current simulation as an integer. More...
 
string get_iteration_as_string () const
 Return the current iteration as a string. More...
 
string get_max_iteration_as_string () const
 Return the number of iterations that will be run in the current simulation as an string. More...
 
Size get_num_digits (Size value) const
 Return the number of digits in the given number. More...
 

Detailed Description

Display a progress bar that updates after each iteration.

Constructor & Destructor Documentation

protocols::loop_modeling::loggers::ProgressBar::ProgressBar ( string  label = "")

Constructor with optional label argument.

Member Function Documentation

void protocols::loop_modeling::loggers::ProgressBar::log_iteration_ ( Pose const &  pose)
virtual

Member Data Documentation

string protocols::loop_modeling::loggers::ProgressBar::label_
private

Referenced by log_iteration_().


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