NullProgressMeter.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_NULLPROGRESSMETER_H
#define MYRAMATH_JOBGRAPH_NULLPROGRESSMETER_H

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

#include <myramath/jobgraph/ProgressMeter.h>

namespace myra {

class NullProgressMeter : public ProgressMeterBase
  {
  public:
  
    // Default constructor.
    NullProgressMeter()
      { }

    // Virtual destructor, so subtypes can release resources.
    virtual ~NullProgressMeter() 
      { }

  protected:

    // Does nothing.
    virtual void begin(const std::string& name, uint64_t total) 
      { }

    // Does nothing.
    virtual void increment(uint64_t delta) 
      { }

    // Does nothing.
    virtual void end() 
      { }

    // Returns false.
    virtual bool kill()
      { return false; }

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

  };

LIBPUBLIC ProgressMeter make_NullProgressMeter();

} // namespace

#endif