Interface to start timer. More...

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

Inheritance diagram for imt::base::dff::runtime::TimerServiceIfc:

Public Member Functions
virtual	~TimerServiceIfc ()
	Destructor. More...

virtual void	startOneShotTimer (RuntimeTimer::TimerHandle &timerToStart, uint32_t const timerTicksMs) const =0
	Starts or restarts the given one shot timer for this ActivePart. More...

virtual void	startPeriodicTimer (RuntimeTimer::TimerHandle &timerToStart, uint32_t const intervalMs) const =0
	Start a periodic timer for this ActivePart. More...

virtual void	killTimer (RuntimeTimer::TimerHandle &timerToKill) const =0
	Kill an existing timer. More...

Detailed Description

Interface to start timer.

Note: The executable has to be registered in RuntimeCore::create in order to receive events.

Constructor & Destructor Documentation

virtual imt::base::dff::runtime::TimerServiceIfc::~TimerServiceIfc ( )

inlinevirtual

Destructor.

virtual void imt::base::dff::runtime::TimerServiceIfc::killTimer ( RuntimeTimer::TimerHandle & timerToKill ) const

pure virtual

Kill an existing timer.

In case the timer is not active anymore, the timerHandle will be set to invalid.

Parameters

timerToKill Handle of the timer to be killed.

virtual void imt::base::dff::runtime::TimerServiceIfc::startOneShotTimer	(	RuntimeTimer::TimerHandle &	timerToStart,
		uint32_t const	timerTicksMs
	)		const

pure virtual

Starts or restarts the given one shot timer for this ActivePart.

In case of invalid parameters, timerToStart is set to an invalid time handle.

Parameters

timerToStart	Timer to be started.
timerTicksMs	Timeout in milliseconds (has to be > 0).

virtual void imt::base::dff::runtime::TimerServiceIfc::startPeriodicTimer	(	RuntimeTimer::TimerHandle &	timerToStart,
		uint32_t const	intervalMs
	)		const

pure virtual

Start a periodic timer for this ActivePart.

In case of invalid parameters, an invalid time handle is returned.

Parameters

timerToStart	Timer to be started.
intervalMs	Timer period in milliseconds.

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