liblec::lecui::timer_manager Class Reference

Timer manager class. More...

#include <timer.h>

Public Member Functions
	timer_manager (form &fm)
	Timer manager constructor. More...
	~timer_manager ()
	Destructor.
void	add (const std::string &alias, const unsigned long &milliseconds, std::function< void()> on_timer)
	Add a timer. More...
bool	running (const std::string &alias)
	Check if a specific timer is running. More...
void	stop (const std::string &alias)
	Stop a specific timer. More...

Detailed Description

Timer manager class.

Constructor & Destructor Documentation

timer_manager()

liblec::lecui::timer_manager::timer_manager

(

form &

fm

)

Timer manager constructor.

Parameters

fm	A reference to the form.

Member Function Documentation

add()

void liblec::lecui::timer_manager::add	(	const std::string &	alias,
		const unsigned long &	milliseconds,
		std::function< void()>	on_timer
	)

Add a timer.

Parameters

alias	The in-form unique alias, e.g. "activation_timer".
milliseconds	The cycle duration.
on_timer	The handler that's called after the duration.

The timer will keep running until stopped manually, with the handler getting called repeatedly in a cycle.

running()

bool liblec::lecui::timer_manager::running

(

const std::string &

alias

)

Check if a specific timer is running.

Parameters

alias

The timer's unique alias.

Returns

True if the timer is running, else false.

stop()

void liblec::lecui::timer_manager::stop

(

const std::string &

alias

)

Stop a specific timer.

Parameters

alias

The timer's unique alias.

---

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

• utilities/timer.h