progress_meter.H

/*
 * This file is part of the "Archon" framework.
 * (http://files3d.sourceforge.net)
 *
 * Copyright © 2002 by Kristian Spangsege and Brian Kristiansen.
 *
 * Permission to use, copy, modify, and distribute this software and
 * its documentation under the terms of the GNU General Public License is
 * hereby granted. No representations are made about the suitability of
 * this software for any purpose. It is provided "as is" without express
 * or implied warranty. See the GNU General Public License
 * (http://www.gnu.org/copyleft/gpl.html) for more details.
 *
 * The characters in this file are ISO8859-1 encoded.
 *
 * The documentation in this file is in "Doxygen" style
 * (http://www.doxygen.org).
 */

#ifndef UTILITIES_PROGRESS_METER_H
#define UTILITIES_PROGRESS_METER_H

// ANSI-C++ headers:
#include <string>

namespace Archon
{
  namespace Utilities
  {
    struct ProgressBase
    {
      /*
       * Place the call to this method after each unit of work.
       * That is, if the work units are the iterations of a loop
       * then the call should be placed as the very last thing in the loop.
       */
      void tick() { if(++skippedWorkUnits == workUnitsPerUpdate) update(); }

    protected:
      const unsigned long totalWorkUnits;
      unsigned long completedWorkUnits;
      unsigned long updateTime;

      ProgressBase(unsigned long totalWorkUnits);
      virtual ~ProgressBase() {}
      virtual void display() = 0;

    private:
      static const unsigned long millisBetweenUpdates = 250;
      unsigned long skippedWorkUnits;
      unsigned long workUnitsPerUpdate;

      unsigned long getTimeInMilliSeconds();
      void update();
    };

    struct ProgressBar: ProgressBase
    {
      ProgressBar(unsigned long totalWorkUnits, int width = 60,
                  bool extraResolution = false, std::string leadText = ""):
        ProgressBase(totalWorkUnits), width(width),
        extraResolution(extraResolution), leadText(leadText) {}

      virtual ~ProgressBar() {}

    private:
      const int width;
      const bool extraResolution;
      const std::string leadText;

      void display();
    };

    struct ProgressStatus: ProgressBase
    {
      ProgressStatus(unsigned long totalWorkUnits, std::string leadText = ""):
        ProgressBase(totalWorkUnits), leadText(leadText), startTime(updateTime) {}

      virtual ~ProgressStatus() {}

    private:
      static const unsigned long millisUntilFirstTotalTimeEstimate = 2000;
      const std::string leadText;
      const unsigned long startTime;

      void display();
    };
  }
}

#endif // UTILITIES_PROGRESS_METER_H

---