MultipleProgressMeter.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_MULTIPLEPROGRESSMETER_H
#define MYRAMATH_JOBGRAPH_MULTIPLEPROGRESSMETER_H

#include <myramath/MYRAMATH_EXPORT.h>

#include <myramath/jobgraph/ProgressMeter.h>

#include <vector>

namespace myra {

// Encapsulates a composition of multiple ProgressMeter's.
class MultipleProgressMeter : public ProgressMeterBase
  {
  public:

    // Default constructor.
    MultipleProgressMeter();

    // Appends another ProgressMeter.
    void push_back(const ProgressMeter& p);

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

  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:

    // Internal contents.
    typedef std::vector<ProgressMeter> ProgressMeters;
    ProgressMeters progress;

  };

MYRAMATH_EXPORT ProgressMeter make_MultipleProgressMeter(const ProgressMeter& p0, const ProgressMeter& p1);
MYRAMATH_EXPORT ProgressMeter make_MultipleProgressMeter(const ProgressMeter& p0, const ProgressMeter& p1, const ProgressMeter& p2);
MYRAMATH_EXPORT ProgressMeter make_MultipleProgressMeter(const ProgressMeter& p0, const ProgressMeter& p1, const ProgressMeter& p2, const ProgressMeter& p3);

} // namespace

#endif