imt::base::dff::activeparts::OneShotTimer Class Reference

A one shot timer to be used in an active part. More...

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

Public Member Functions
	OneShotTimer (imt::base::dff::runtime::TimerServiceIfc &timer, const uint32_t timeoutMs)
	Constructor. More...
	~OneShotTimer (void)
	Destructor.
void	startTimeout (void)
	Start the oneshot timer.
void	stop (void)
	Stop the oneshot timer.
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...
void	clearTimerHandle (void)
	Clear the timer handle. More...

Detailed Description

A one shot timer to be used in an active part.

The timer triggers once after the given delay in milliseconds has elapsed.

Constructor & Destructor Documentation

OneShotTimer()

imt::base::dff::activeparts::OneShotTimer::OneShotTimer ( imt::base::dff::runtime::TimerServiceIfc &  timer, const uint32_t  timeoutMs  )

explicit

Constructor.

Parameters

timer	The activepart's timer interface.
timeoutMs	The specified timeout value in milliseconds.

Member Function Documentation

clearTimerHandle()

void imt::base::dff::activeparts::OneShotTimer::clearTimerHandle

(

void

)

Clear the timer handle.

Invalidates the timer handle.

getTimerId()

imt::base::dff::runtime::RuntimeTimer::TimerHandle imt::base::dff::activeparts::OneShotTimer::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::OneShotTimer::isRunning

(

void

)

const

Check if the timer is running.

Returns

bool true if running, false if otherwise.

---

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

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