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

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

Public Member Functions
	VariableOneShotTimer (imt::base::dff::runtime::TimerServiceIfc &timer)
	Constructor. More...

	~VariableOneShotTimer (void)
	Destructor. More...

void	startTimeout (const uint32_t timeoutMs)
	Start the oneshot timer. More...

void	stop (void)
	Stop the oneshot 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...

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

◆ VariableOneShotTimer()

imt::base::dff::activeparts::VariableOneShotTimer::VariableOneShotTimer ( imt::base::dff::runtime::TimerServiceIfc & timer )

explicit

Constructor.

Parameters

timer The activepart's timer interface.

◆ ~VariableOneShotTimer()

imt::base::dff::activeparts::VariableOneShotTimer::~VariableOneShotTimer ( void )

Destructor.

Member Function Documentation

◆ clearTimerHandle()

void imt::base::dff::activeparts::VariableOneShotTimer::clearTimerHandle ( void )

Clear the timer handle.

Invalidates the timer handle.

◆ getTimerId()

imt::base::dff::runtime::RuntimeTimer::TimerHandle imt::base::dff::activeparts::VariableOneShotTimer::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::VariableOneShotTimer::isRunning ( void ) const

Check if the timer is running.

Returns: bool true if running, false if otherwise.

◆ startTimeout()

void imt::base::dff::activeparts::VariableOneShotTimer::startTimeout ( const uint32_t timeoutMs )

Start the oneshot timer.

Parameters

timeoutMs The specified timeout value in milliseconds.

◆ stop()

void imt::base::dff::activeparts::VariableOneShotTimer::stop ( void )

Stop the oneshot timer.

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

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

Public Member Functions