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

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

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

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

Detailed Description

A periodic timer to be used in an active part.

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

Constructor & Destructor Documentation

PeriodicTimer()

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

explicit

Constructor.

Parameters

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

~PeriodicTimer()

imt::base::dff::activeparts::PeriodicTimer::~PeriodicTimer

(

void

)

Destructor.

Member Function Documentation

getTimerId()

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

(

void

)

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

(

void

)

const

Check if the timer is running.

Returns

bool true if running, false if otherwise.

startTimer()

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

(

void

)

Start the periodic timer.

stop()

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

(

void

)

Stop the periodic timer.

---

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

• D:/_Work/10/s/Imt.Base/Imt.Base.Dff.ActiveParts/PeriodicTimer.h