progresshandler.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  qt-mvvm: Model-view-view-model framework for large GUI applications
//
//! @file      mvvm/model/mvvm/utils/progresshandler.cpp
//! @brief     Implements class CLASS?
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2020
//! @authors   Gennady Pospelov et al, Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#include "mvvm/utils/progresshandler.h"
 
using namespace ModelView;
 
ProgressHandler::ProgressHandler(ProgressHandler::callback_t callback, size_t max_ticks_count)
    : runner_callback(std::move(callback)), max_ticks_count(max_ticks_count)
{
}
 
void ProgressHandler::subscribe(ProgressHandler::callback_t callback)
{
    runner_callback = std::move(callback);
}
 
//! Sets expected ticks count, representing progress of a computation.
 
void ProgressHandler::setMaxTicksCount(size_t value)
{
    reset();
    max_ticks_count = value;
}
 
bool ProgressHandler::has_interrupt_request() const
{
    return interrupt_request;
}
 
//! Increment number of completed computation steps. Performs callback to inform
//! subscriber about current progress (in percents) and retrieves interrupt request flag.
 
void ProgressHandler::setCompletedTicks(size_t value)
{
    std::unique_lock<std::mutex> lock(mutex);
    completed_ticks += value;
    if (completed_ticks > max_ticks_count)
        max_ticks_count = completed_ticks + 1;
    int percentage_done = static_cast<int>(100.0 * completed_ticks / max_ticks_count);
    interrupt_request = runner_callback ? runner_callback(percentage_done) : interrupt_request;
}
 
//! Resets progress.
 
void ProgressHandler::reset()
{
    interrupt_request = false;
    completed_ticks = 0;
}