UserProgressMeter.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_USERPROGRESSMETER_H
#define MYRAMATH_JOBGRAPH_USERPROGRESSMETER_H

#include <myramath/jobgraph/ProgressMeter.h>

namespace myra {

// Implementation detail.
template<class UserClass> class UserProgressMeter : public ProgressMeterBase
  {
  public:

    // Constructor, requires a copy constructible UserClass.
    UserProgressMeter(const UserClass& in_u)
      : u(in_u) { }

  protected:

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

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

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

    // Regularly polled while a JobGraph execute()'s, execution will halt if kill()==true.
    virtual bool kill()
      { return u.kill(); }

    // Virtual copy constructor.
    ProgressMeterBase* clone() const
      { return new UserProgressMeter(u); }

  private:
  
    // Deep copy of user's class.
    UserClass u;
    
  };

template<class UserClass> ProgressMeter make_UserProgressMeter(const UserClass& u)
  { return UserProgressMeter<UserClass>(u); }

} // namespace myra

#endif