Collaboration diagram for ProgressHandler:

Public Types
typedef std::function< bool(size_t)>	Callback_t

Public Member Functions
	ProgressHandler ()

	ProgressHandler (const ProgressHandler &other)

void	subscribe (ProgressHandler::Callback_t callback)

void	reset ()

void	setExpectedNTicks (size_t n)

void	incrementDone (size_t ticks_done)

bool	alive ()

Private Member Functions
bool	defaultMonitorExec (int)

Private Attributes
Callback_t	m_inform

size_t	m_expected_nticks

size_t	m_completed_nticks

bool	m_continuation_flag

Detailed Description

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.

Definition at line 30 of file ProgressHandler.h.

Member Typedef Documentation

◆ Callback_t

typedef std::function<bool(size_t)> ProgressHandler::Callback_t

Definition at line 33 of file ProgressHandler.h.

Constructor & Destructor Documentation

◆ ProgressHandler() [1/2]

ProgressHandler::ProgressHandler ( )

inline

Definition at line 35 of file ProgressHandler.h.

         : m_inform(nullptr), m_expected_nticks(0), m_completed_nticks(0), m_continuation_flag(true)
     {
     }

◆ ProgressHandler() [2/2]

ProgressHandler::ProgressHandler ( const ProgressHandler & other )

inline

Definition at line 39 of file ProgressHandler.h.

         : 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)
     {
     }

Member Function Documentation

◆ subscribe()

void ProgressHandler::subscribe ( ProgressHandler::Callback_t callback )

Definition at line 19 of file ProgressHandler.cpp.

 {
     if (m_inform)
         throw std::runtime_error("Invalid call of ProgressHandler::subscribe: "
                                  "currently, no more than one subscriber is allowed");
     m_inform = inform;
 }

References m_inform.

Referenced by Simulation::setTerminalProgressMonitor(), and Simulation::subscribe().

◆ reset()

void ProgressHandler::reset ( )

inline

Definition at line 46 of file ProgressHandler.h.

     {
         m_completed_nticks = 0;
         m_continuation_flag = true;
     }

References m_completed_nticks, and m_continuation_flag.

Referenced by Simulation::runSimulation().

◆ setExpectedNTicks()

void ProgressHandler::setExpectedNTicks ( size_t n )

inline

Definition at line 51 of file ProgressHandler.h.

51 { m_expected_nticks = n; }

References m_expected_nticks.

Referenced by Simulation::runSimulation().

◆ incrementDone()

void ProgressHandler::incrementDone ( size_t ticks_done )

Increments number of completed computation steps (ticks).

Performs callback (method m_inform) to inform the subscriber about the state of the computation and to obtain as return value a flag that indicates whether to continue the computation.

Definition at line 31 of file ProgressHandler.cpp.

 {
     static std::mutex single_mutex;
     std::unique_lock<std::mutex> single_lock(single_mutex);
  
     m_completed_nticks += ticks_done;
     if (m_completed_nticks > m_expected_nticks)
         m_expected_nticks = m_completed_nticks + 1;
  
     int percentage_done = (int)(100. * m_completed_nticks / m_expected_nticks);
     // fractional part is discarded, which is fine here:
     // the value 100 is only returned if everything is done
  
     m_continuation_flag = (!m_inform || m_inform(percentage_done)) && m_continuation_flag;
 }