TextProgressMeter.h

Go to the documentation of this file.

// ========================================================================= //
// This file is part of MyraMath, copyright (c) 2014-2019 by Ryan A Chilton  //
// and distributed by MyraCore, LLC. See LICENSE.txt for license terms.      //
// ========================================================================= //

#ifndef MYRAMATH_JOBGRAPH_TEXTPROGRESSMETER_H
#define MYRAMATH_JOBGRAPH_TEXTPROGRESSMETER_H

#include <myramath/utility/detail/LIBPUBLIC.h>
#include <myramath/utility/Timer.h>

#include <myramath/jobgraph/ProgressMeter.h>

namespace myra {

// Displays a text ProgressMeter on console output.
class TextProgressMeter : public ProgressMeterBase
  {
  public:

    // Default constructor.
    TextProgressMeter();

    // Virtual destructor, so subtypes can release resources.
    virtual ~TextProgressMeter();

  protected:

    // Called when a lengthy calculation is started.
    virtual void begin(const std::string& name, uint64_t total);

    // Called repeatedly between begin() and end(), to regularly increment progress.
    virtual void increment(uint64_t delta);

    // Called when a lengthy calculation is finished.
    virtual void end();

    // Returns false, a TextProgressMeter will never kill a JobGraph.
    virtual bool kill();
    
    // Virtual copy constructor.
    virtual ProgressMeterBase* clone() const;

  private:

    // Draws a bar graph on the console, like [-----    ] (%d seconds)
    void draw() const;

    // Set by begin()
    bool started;

    // Current and total work.
    uint64_t w_current;
    uint64_t w_total;

    // Current and total characters.
    int c_current;
    int c_total;

    // Measures time since start, in milliseconds.
    Timer timer;
    int t_current;

  };

LIBPUBLIC ProgressMeter make_TextProgressMeter();

} // namespace

#endif