RunMultipleSteps.h

Go to the documentation of this file.

// This file is part of the Peano project. For conditions of distribution and
// use, please see the copyright notice at www.peano-framework.org
#pragma once
 
#include <functional>
#include <string>
#include <vector>
 
#include "tarch/timing/Watch.h"
#include "tarch/timing/Measurement.h"
 
 
namespace peano4 {
  class RunMultipleSteps;
}
 
 
class peano4::RunMultipleSteps {
  public:
    class Report {
      public:
        virtual ~Report() = default;
 
        virtual void reportStep(const RunMultipleSteps& step) = 0;
 
        virtual void reportFinalResults(const std::vector<std::reference_wrapper<RunMultipleSteps>>& steps) = 0;
    };
 
    RunMultipleSteps(const std::string& name, int firstSubstep);
    virtual ~RunMultipleSteps() = default;
 
    virtual void run() = 0;
 
    tarch::timing::Measurement getRuntimeMeasurements() const;
 
    int getFirstSubstep() const;
 
    std::string getName() const;
 
  protected:
 
    const std::string          _name;
 
    const int                  _firstSubstep;
 
    tarch::timing::Watch       _watch;
 
    tarch::timing::Measurement _runtimeMeasurement;
};