ProgressMeasurement.h

Go to the documentation of this file.

#pragma once
 
#include <boost/optional.hpp>
#include <chrono>
#include <cstdint>
#include <ostream>
 
namespace storm {
namespace utility {
 
// The default minimal delay (in seconds) between two progress messages, used when no specific delay is requested.
constexpr uint64_t defaultProgressMeasurementDelay = 5;

class ProgressMeasurement {
   public:
    typedef decltype(std::chrono::duration_cast<std::chrono::seconds>(std::chrono::seconds::zero()).count()) SecondType;
    typedef decltype(std::chrono::duration_cast<std::chrono::milliseconds>(std::chrono::milliseconds::zero()).count()) MilisecondType;
    typedef decltype(std::chrono::duration_cast<std::chrono::nanoseconds>(std::chrono::nanoseconds::zero()).count()) NanosecondType;

    ProgressMeasurement(std::string const& itemName, uint64_t delay = defaultProgressMeasurementDelay);

    void startNewMeasurement(uint64_t startCount);

    bool updateProgress(uint64_t count);

    bool updateProgress(uint64_t count, std::ostream& outstream);

    bool isMaxCountSet() const;

    uint64_t getMaxCount() const;

    void setMaxCount(uint64_t maxCount);

    void unsetMaxCount();

    uint64_t getShowProgressDelay() const;

    void setShowProgressDelay(uint64_t delay);

    std::string const& getItemName() const;

    void setItemName(std::string const& name);
 
   private:
    // The delay (in seconds) between progress emission.
    uint64_t delay;
    // A name for what this is measuring (iterations, states, ...)
    std::string itemName;
 
    // The maximal count that can be achieved. numeric_limits<uint64_t>::max() means unspecified.
    uint64_t maxCount;
 
    // The last displayed count
    uint64_t lastDisplayedCount;
 
    std::chrono::high_resolution_clock::time_point timeOfStart;
    std::chrono::high_resolution_clock::time_point timeOfLastMessage;
};
 
}  // namespace utility
}  // namespace storm