PLearn::ProgressBar Class Reference

This class will help you display progress of a calculation. More...

#include <ProgressBar.h>

Collaboration diagram for PLearn::ProgressBar:

[legend]List of all members.

Public Member Functions
	ProgressBar (string _title, unsigned long the_maxpos)
	ProgressBar (ostream &_out, string _title, unsigned long the_maxpos)
	ProgressBar (PStream &_out, string _title, unsigned long the_maxpos)
void	operator() (unsigned long newpos)
void	update (unsigned long newpos)
void	close ()
	~ProgressBar ()
Static Public Member Functions
void	setPlugin (PP< ProgressBarPlugin > plugin_)
PP< ProgressBarPlugin >	getCurrentPlugin ()
Public Attributes
string	title
unsigned long	currentpos
unsigned long	maxpos
Private Attributes
bool	closed
Static Private Attributes
PP< ProgressBarPlugin >	plugin

---

Detailed Description

This class will help you display progress of a calculation.

Each progressBar you create is connected to the same ProgressBarPlugin object. By default, a TextProgressBarPlugin that dumps the text in stderr is created and used.

FAQ: Q #1 : How do I reuse the same progress bar? A #1 : simply call progress_bar(i) again with 'i' from 0..maxpos (The text progress bar plugin will display a new progress bar)

Definition at line 109 of file ProgressBar.h.

---

Constructor & Destructor Documentation

PLearn::ProgressBar::ProgressBar (  string  _title, unsigned long  the_maxpos )

Definition at line 66 of file ProgressBar.cc. References plugin.

PLearn::ProgressBar::ProgressBar (  ostream &  _out, string  _title, unsigned long  the_maxpos )

Definition at line 75 of file ProgressBar.cc. References plugin.

PLearn::ProgressBar::ProgressBar (  PStream &  _out, string  _title, unsigned long  the_maxpos )

Definition at line 83 of file ProgressBar.cc. References plugin.

PLearn::ProgressBar::~ProgressBar (   )

Definition at line 92 of file ProgressBar.cc. References close().

---

Member Function Documentation

void PLearn::ProgressBar::close (   )

Definition at line 97 of file ProgressBar.cc. References closed, currentpos, maxpos, operator()(), and plugin. Referenced by PLearn::DX_create_grid_outputs_file(), PLearn::SequentialModelSelector::test(), PLearn::SequentialModelSelector::train(), and ~ProgressBar().

PP< ProgressBarPlugin > PLearn::ProgressBar::getCurrentPlugin (   )  [static]

Definition at line 59 of file ProgressBar.cc. References plugin.

void PLearn::ProgressBar::operator() (  unsigned long  newpos  )  [inline]

Definition at line 124 of file ProgressBar.h. References operator()(), and plugin. Referenced by close(), and operator()().

void PLearn::ProgressBar::setPlugin (  PP< ProgressBarPlugin >  plugin_  )  [inline, static]

Definition at line 129 of file ProgressBar.h. References plugin, and setPlugin(). Referenced by setPlugin().

void PLearn::ProgressBar::update (  unsigned long  newpos  )  [inline]

Definition at line 126 of file ProgressBar.h. References plugin. Referenced by PLearn::Kernel::apply(), PLearn::DatedJoinVMatrix::build_(), PLearn::compute_learner_outputs_on_grid(), PLearn::Kernel::computeGramMatrix(), PLearn::Kernel::computeKNNeighbourMatrixFromDistanceMatrix(), PLearn::ReconstructionWeightsKernel::computeLLEMatrix(), PLearn::Kernel::computeNeighbourMatrixFromDistanceMatrix(), PLearn::computeOutputFields(), PLearn::computeStats(), PLearn::ReconstructionWeightsKernel::computeWeights(), PLearn::DX_create_dataset_outputs_file(), PLearn::DX_create_grid_outputs_file(), PLearn::ConcatRowsVMatrix::ensureMappingsConsistency(), PLearn::ConcatRowsVMatrix::fullyCheckMappings(), PLearn::FilteredVMatrix::openIndex(), PLearn::VMatrix::saveAMAT(), PLearn::GeodesicDistanceKernel::setDataForKernelMatrix(), PLearn::SequentialModelSelector::test(), PLearn::PLearner::test(), PLearn::MovingAverage::test(), PLearn::EmbeddedSequentialLearner::test(), PLearn::TangentLearner::train(), PLearn::SequentialModelSelector::train(), PLearn::PLS::train(), PLearn::PCA::train(), PLearn::NNet::train(), PLearn::NeighborhoodSmoothnessNNet::train(), PLearn::MultiInstanceNNet::train(), PLearn::MovingAverage::train(), PLearn::GaussMix::train(), PLearn::GaussianContinuum::train(), PLearn::ConditionalDensityNet::train(), PLearn::AdaBoost::train(), and PLearn::PLearner::use().

---

Member Data Documentation

bool PLearn::ProgressBar::closed [private]

Definition at line 138 of file ProgressBar.h. Referenced by close().

unsigned long PLearn::ProgressBar::currentpos

Definition at line 113 of file ProgressBar.h. Referenced by close(), and PLearn::TextProgressBarPlugin::update().

unsigned long PLearn::ProgressBar::maxpos

Definition at line 114 of file ProgressBar.h. Referenced by PLearn::TextProgressBarPlugin::addProgressBar(), close(), and PLearn::TextProgressBarPlugin::update().

PP< ProgressBarPlugin > PLearn::ProgressBar::plugin [static, private]

Definition at line 57 of file ProgressBar.cc. Referenced by close(), getCurrentPlugin(), operator()(), ProgressBar(), setPlugin(), and update().

string PLearn::ProgressBar::title

Definition at line 112 of file ProgressBar.h. Referenced by PLearn::TextProgressBarPlugin::addProgressBar(), and PLearn::TextProgressBarPlugin::update().

---

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

• ProgressBar.h
• ProgressBar.cc

---