1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
// ************************************************************************************************
//
// BornAgain: simulate and fit reflection and scattering
//
//! @file Base/Progress/ProgressHandler.h
//! @brief Defines class ProgressHandler.
//!
//! @homepage http://www.bornagainproject.org
//! @license GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
// ************************************************************************************************
#ifdef SWIG
#error no need to expose this header to Swig
#endif // SWIG
#ifndef BORNAGAIN_BASE_PROGRESS_PROGRESSHANDLER_H
#define BORNAGAIN_BASE_PROGRESS_PROGRESSHANDLER_H
#include <functional>
//! Maintains information about progress of a computation.
//!
//! Owner is the computation, which periodically calls the thread-safe function incrementDone(..).
//! An application (GUI or script) may subscribe(..) to be informed about progress.
//! It is then periodically called back by inform(..).
//! The return value of inform(..) can be used to request termination of the computation.
class ProgressHandler {
public:
using Callback_t = std::function<bool(size_t)>;
ProgressHandler()
: m_inform(nullptr)
{
}
ProgressHandler(const ProgressHandler& other)
: m_inform(other.m_inform) // not clear whether we want multiple copies of this
, m_expected_nticks(other.m_expected_nticks)
, m_completed_nticks(other.m_completed_nticks)
{
}
void subscribe(Callback_t inform);
void reset()
{
m_completed_nticks = 0;
m_continuation_flag = true;
}
void setExpectedNTicks(size_t n) { m_expected_nticks = n; }
void incrementDone(size_t ticks_done);
bool alive() { return m_continuation_flag; }
private:
Callback_t m_inform;
size_t m_expected_nticks{0};
size_t m_completed_nticks{0};
bool m_continuation_flag{true};
bool defaultMonitorExec(int);
};
#endif // BORNAGAIN_BASE_PROGRESS_PROGRESSHANDLER_H
|
