BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
DelayedProgressCounter Class Reference
Collaboration diagram for DelayedProgressCounter:

Public Member Functions

 DelayedProgressCounter (ProgressHandler *p_progress, size_t interval)
 
 ~DelayedProgressCounter ()
 
void stepProgress ()
 

Private Attributes

ProgressHandlermp_progress
 
const size_t m_interval
 
size_t m_count
 

Detailed Description

Counter for reporting progress (with delay interval) in a threaded computation.

Definition at line 24 of file DelayedProgressCounter.h.

Constructor & Destructor Documentation

◆ DelayedProgressCounter()

DelayedProgressCounter::DelayedProgressCounter ( ProgressHandler p_progress,
size_t  interval 
)

Definition at line 18 of file DelayedProgressCounter.cpp.

19  : mp_progress(p_progress), m_interval(interval), m_count(0)
20 {
21 }

◆ ~DelayedProgressCounter()

DelayedProgressCounter::~DelayedProgressCounter ( )
inline

Definition at line 28 of file DelayedProgressCounter.h.

28 {}

Member Function Documentation

◆ stepProgress()

void DelayedProgressCounter::stepProgress ( )

Increments inner counter; at regular intervals updates progress handler.

Definition at line 23 of file DelayedProgressCounter.cpp.

24 {
25  ++m_count;
26  if (m_count == m_interval) {
28  m_count = 0;
29  }
30 }
void incrementDone(size_t ticks_done)
Increments number of completed computation steps (ticks).

References ProgressHandler::incrementDone(), m_count, m_interval, and mp_progress.

Here is the call graph for this function:

Member Data Documentation

◆ mp_progress

ProgressHandler* DelayedProgressCounter::mp_progress
private

Definition at line 34 of file DelayedProgressCounter.h.

Referenced by stepProgress().

◆ m_interval

const size_t DelayedProgressCounter::m_interval
private

Definition at line 35 of file DelayedProgressCounter.h.

Referenced by stepProgress().

◆ m_count

size_t DelayedProgressCounter::m_count
private

Definition at line 36 of file DelayedProgressCounter.h.

Referenced by stepProgress().


The documentation for this class was generated from the following files: