UpdateTimer Class Reference

Description

The UpdateTimer class accumulates update requests during certain period of time, and at the end of this period emits special signal.

Used in ColorMap plot to avoid often replot of CustomPlot.

Definition at line 27 of file UpdateTimer.h.

Inheritance diagram for UpdateTimer:

Collaboration diagram for UpdateTimer:

Public Slots
void	scheduleUpdate ()

Signals
void	timeToUpdate ()

Public Member Functions
	UpdateTimer (int timerInterval, QObject *parent=nullptr)
void	reset ()
void	setWallclockTimer (int timerInterval)

Private Slots
void	onTimerTimeout ()

Private Attributes
bool	m_is_busy
QTimer *	m_timer
int	m_timer_interval
	Timer in msec. More...
qint64	m_update_request_count
	Number of requests accumulated so far. More...

Constructor & Destructor Documentation

UpdateTimer()

UpdateTimer::UpdateTimer ( int  timerInterval, QObject *  parent = nullptr  )

explicit

Definition at line 18 of file UpdateTimer.cpp.

    : QObject(parent)
    , m_update_request_count(0)
    , m_timer_interval(timerInterval)
    , m_is_busy(false)
    , m_timer(new QTimer(this))
{
    m_timer->setInterval(m_timer_interval);
    m_timer->setSingleShot(true);
    connect(m_timer, &QTimer::timeout, this, &UpdateTimer::onTimerTimeout);
}

References m_timer, m_timer_interval, and onTimerTimeout().

Here is the call graph for this function:

Member Function Documentation

onTimerTimeout

void UpdateTimer::onTimerTimeout ( )

privateslot

Definition at line 53 of file UpdateTimer.cpp.

{
    m_is_busy = true;
 
    if (m_update_request_count > 0) {
        m_update_request_count = 0;
        emit timeToUpdate();
    }
 
    m_is_busy = false;
}

References m_is_busy, m_update_request_count, and timeToUpdate().

Referenced by UpdateTimer().

reset()

void UpdateTimer::reset

(

)

Definition at line 30 of file UpdateTimer.cpp.

{
    m_update_request_count = 0;
    m_timer->stop();
    m_is_busy = false;
}

References m_is_busy, m_timer, and m_update_request_count.

Referenced by ScriptPanel::hideEvent(), AutosaveController::onDocumentDestroyed(), AutosaveController::setAutosaveTime(), and AutosaveController::setDocument().

scheduleUpdate

void UpdateTimer::scheduleUpdate ( )

slot

Definition at line 42 of file UpdateTimer.cpp.

{
    if (m_is_busy)
        return;
 
    ++m_update_request_count;
 
    if (!m_timer->isActive())
        m_timer->start(m_timer_interval);
}

References m_is_busy, m_timer, m_timer_interval, and m_update_request_count.

Referenced by AutosaveController::onDocumentModified(), ScriptPanel::onSampleModified(), Plot1D::replot(), SpecularPlot::replot(), ColorMap::replot(), and ScriptPanel::showEvent().

setWallclockTimer()

void UpdateTimer::setWallclockTimer

(

int

timerInterval

)

Definition at line 37 of file UpdateTimer.cpp.

{
    m_timer_interval = timerInterval;
}

References m_timer_interval.

Referenced by AutosaveController::setAutosaveTime().

timeToUpdate

void UpdateTimer::timeToUpdate ( )

signal

Referenced by AutosaveController::AutosaveController(), ScriptPanel::ScriptPanel(), onTimerTimeout(), Plot1D::setUpdateTimerConnected(), SpecularPlot::setUpdateTimerConnected(), and ColorMap::setUpdateTimerConnected().

Member Data Documentation

m_is_busy

bool UpdateTimer::m_is_busy

private

Definition at line 48 of file UpdateTimer.h.

Referenced by onTimerTimeout(), reset(), and scheduleUpdate().

m_timer

QTimer* UpdateTimer::m_timer

private

Definition at line 49 of file UpdateTimer.h.

Referenced by UpdateTimer(), reset(), and scheduleUpdate().

m_timer_interval

int UpdateTimer::m_timer_interval

private

Timer in msec.

Definition at line 47 of file UpdateTimer.h.

Referenced by UpdateTimer(), scheduleUpdate(), and setWallclockTimer().

m_update_request_count

qint64 UpdateTimer::m_update_request_count

private

Number of requests accumulated so far.

Definition at line 46 of file UpdateTimer.h.

Referenced by onTimerTimeout(), reset(), and scheduleUpdate().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Tool/UpdateTimer.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/View/Tool/UpdateTimer.cpp