ProgressMonitor.h

Go to the documentation of this file.

 
#ifndef LLU_PROGRESSMONITOR_H
#define LLU_PROGRESSMONITOR_H
 
#include "LLU/Containers/Tensor.h"
 
namespace LLU {
 
    class ProgressMonitor {
    public:
        using SharedTensor = Tensor<double>;
 
        explicit ProgressMonitor(SharedTensor sharedIndicator, double step = defaultStep);
 
        ProgressMonitor(const ProgressMonitor&) = delete;
        ProgressMonitor& operator=(const ProgressMonitor&) = delete;
 
        ProgressMonitor(ProgressMonitor&&) = default;
        ProgressMonitor& operator=(ProgressMonitor&&) = default;
 
        ~ProgressMonitor() = default;
 
        double get() const;
 
        void set(double progressValue);
 
        double getStep() const;
 
        void setStep(double stepValue);
 
        static void checkAbort();
 
        ProgressMonitor& operator++();
 
        ProgressMonitor& operator+=(double progress);
 
        ProgressMonitor& operator--();
 
        ProgressMonitor& operator-=(double progress);
 
        static constexpr double getDefaultStep() noexcept {
            return defaultStep;
        }
    private:
        static constexpr double defaultStep = .1;
 
        SharedTensor sharedIndicator;
 
        double step;
    };
 
} // namespace LLU
#endif // LLU_PROGRESSMONITOR_H