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, uint32_t const timeoutMs)
	Constructor. More...
	~OneShotTimer ()
	Destructor. More...
void	startTimeout ()
	Start the oneshot timer. More...
void	stop ()
	Stop the oneshot timer. More...
bool	isRunning () const
	Check if the timer is running. More...
::imt::base::dff::runtime::RuntimeTimer::TimerHandle	getTimerId () const
	Get the handle to identify the timer. More...
void	clearTimerHandle ()
	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, uint32_t const  timeoutMs  )

explicit

Constructor.

Parameters

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

~OneShotTimer()

imt::base::dff::activeparts::OneShotTimer::~OneShotTimer

(

)

Destructor.

Member Function Documentation

clearTimerHandle()

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

(

)

Clear the timer handle.

Invalidates the timer handle.

getTimerId()

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

(

)

const

Check if the timer is running.

Returns

bool true if running, false if otherwise.

startTimeout()

void imt::base::dff::activeparts::OneShotTimer::startTimeout

(

)

Start the oneshot timer.

stop()

void imt::base::dff::activeparts::OneShotTimer::stop

(

)

Stop the oneshot timer.

---

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

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