ProgressBar.h

Go to the documentation of this file.

// -*- C++ -*-

// PLearn (A C++ Machine Learning Library)
// Copyright (C) 1998 Pascal Vincent
// Copyright (C) 1999-2002 Pascal Vincent, Yoshua Bengio and University of Montreal
//

// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// 
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
// 
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
// 
//  3. The name of the authors may not be used to endorse or promote
//     products derived from this software without specific prior written
//     permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
// NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// 
// This file is part of the PLearn library. For more information on the PLearn
// library, go to the PLearn Web site at www.plearn.org


 

/* *******************************************************      
   * $Id: ProgressBar.h,v 1.8 2004/07/21 16:30:50 chrish42 Exp $
   * AUTHORS: Pascal Vincent
   * This file is part of the PLearn library.
   ******************************************************* */

// This file contains useful functions for string manipulation
// that are used in the PLearn Library


#ifndef ProgressBar_INC
#define ProgressBar_INC

#include <string>
//#include <iostream>
#include "PP.h"
#include <plearn/io/PStream.h>


namespace PLearn {
using namespace std;
  
class ProgressBar;

class ProgressBarPlugin : public PPointable
{
public:
  ProgressBarPlugin() {}
  virtual ~ProgressBarPlugin() {}
  virtual void addProgressBar(ProgressBar * pb){};
  virtual void killProgressBar(ProgressBar * pb){};
  virtual void update(ProgressBar * pb, unsigned long newpos){};
};


class TextProgressBarPlugin : public ProgressBarPlugin
{
  PStream out;
public:
  virtual void addProgressBar(ProgressBar * pb);
  virtual void update(ProgressBar * pb, unsigned long newpos);

  TextProgressBarPlugin(ostream& _out);
  TextProgressBarPlugin(PStream& _out);
};


struct NullProgressBarPlugin : public ProgressBarPlugin
{ /* all inherited methods are fine... :-) */ };


class ProgressBar
{
public:
  string title;
  unsigned long currentpos; // current position
  unsigned long maxpos;

  // creates a new progressbar with the given title and maxpos
  // *** Note, for now, ignore the stream (someday, remove this argument for 
  // every progressBar creation in PLearn)
  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);
  
  // moves the progressbar up to position newpos
  void operator()(unsigned long newpos){plugin->update(this,newpos);}
 
  void update(unsigned long newpos){plugin->update(this,newpos);}

  // this function assumes plugin is always a valid object (it is created statically in the .cc)
  static void setPlugin(PP<ProgressBarPlugin> plugin_) { plugin = plugin_; }
  static PP<ProgressBarPlugin> getCurrentPlugin();

  // Completes and removes the progressBar 
  void close();
  
  // calls close() if not already done
  ~ProgressBar();
private:
  bool closed;
  static PP<ProgressBarPlugin> plugin;
};


} // end of namespace PLearn

#endif

---