AbstractProgress.hpp

Go to the documentation of this file.

#ifndef LIBS_CORE_ABSTRACTPROGRESS_HPP_
#define LIBS_CORE_ABSTRACTPROGRESS_HPP_
 
#include <cstdint>
#include <string>
 
class AbstractProgress
{
public:
    AbstractProgress();
    AbstractProgress(const AbstractProgress &other) = delete;
    AbstractProgress(AbstractProgress &&other) = delete;
    virtual ~AbstractProgress();
 
    AbstractProgress &operator=(const AbstractProgress &other) = delete;
    AbstractProgress &operator=(AbstractProgress &&other) = delete;
 
    virtual void begin() = 0;
    virtual void end() = 0;
    void incrElements(uint64_t incrElements, const std::string &extraInfo = "");
    void incrElement(const std::string &extraInfo = "");
 
    void setHeader(const std::string &header);
    void setHeaderWithNumberElements(const std::string &header, uint64_t numElements);
    void setMessage(const std::string &txtMsg);
    void setMessageDestroying(const std::string &txtMsg);
 
    virtual bool isCancelling() = 0;
 
protected:
    virtual void resetProgress() = 0;
    virtual void visibleProgress(bool isVisible) = 0;
    virtual void writeCurrentElements(const std::string &header, uint64_t currentElements,
                                      const std::string &extraInfo) = 0;
    virtual void writeMessage(const std::string &header) = 0;
    virtual void writeWithNumElements(const std::string &header, uint64_t currentElements, uint64_t numElements,
                                      const std::string &extraInfo) = 0;
 
private:
    void prvResetCounter(const std::string &header);
 
    bool m_withElements;
    uint64_t m_numElements;
    uint64_t m_currentElements;
 
    std::string m_header;
};
 
#endif /* LIBS_CORE_ABSTRACTPROGRESS_HPP_ */