imt::base::dff::activeparts::PeriodicTimer Class Reference

A periodic timer to be used in an active part. More...

#include <Imt.Base.Dff.ActiveParts/inc/Imt.Base.Dff.ActiveParts/PeriodicTimer.h>

Inheritance diagram for imt::base::dff::activeparts::PeriodicTimer:

Public Member Functions
	PeriodicTimer (::imt::base::dff::runtime::TimerServiceIfc &timer, uint32_t const intervalMs)
	Constructor.
void	startTimer ()
	Start the periodic timer.
void	stop ()
	Stop the periodic timer.
bool	isRunning () const
	Check if the timer is running.
::imt::base::dff::runtime::RuntimeTimer::TimerHandle	getTimerId () const
	Get the handle to identify the timer.

Detailed Description

A periodic timer to be used in an active part.

The timer triggers everytime the given delay in milliseconds has elapsed.

Definition at line 52 of file PeriodicTimer.h.

Constructor & Destructor Documentation

PeriodicTimer()

imt::base::dff::activeparts::PeriodicTimer::PeriodicTimer	(	::imt::base::dff::runtime::TimerServiceIfc &	timer,
		uint32_t const	intervalMs
	)

Constructor.

Parameters

timer	The activepart's timer interface.
intervalMs	The specified interval value in milliseconds.

Member Function Documentation

getTimerId()

::imt::base::dff::runtime::RuntimeTimer::TimerHandle imt::base::dff::activeparts::PeriodicTimer::getTimerId

(

)

const

Get the handle to identify the timer.

Returns

RuntimeTimer::TimerHandle The timer handle issued by dff upon timer creation

isRunning()

bool imt::base::dff::activeparts::PeriodicTimer::isRunning

(

)

const

Check if the timer is running.

Returns

bool true if running, false if otherwise.

startTimer()

void imt::base::dff::activeparts::PeriodicTimer::startTimer

(

)

Start the periodic timer.

stop()

void imt::base::dff::activeparts::PeriodicTimer::stop

(

)

Stop the periodic timer.

---

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

• C:/src/imt/Imt.Base-cpp/Imt.Base/Imt.Base.Dff.ActiveParts/inc/Imt.Base.Dff.ActiveParts/PeriodicTimer.h