imt::base::dff::runtime::TimerServiceIfc Class Reference

Interface to start timer. More...

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

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

Public Member Functions
virtual RuntimeTimer::TimerHandle	startOneShotTimer (RuntimeTimer::TimerHandle timerToStart, uint32_t const timerTicksMs) const =0
	Starts or restarts the given one shot timer for this ActivePart.
virtual RuntimeTimer::TimerHandle	startPeriodicTimer (RuntimeTimer::TimerHandle timerToStart, uint32_t const intervalMs) const =0
	Start a periodic timer for this ActivePart.
virtual RuntimeTimer::TimerHandle	killTimer (RuntimeTimer::TimerHandle timerToKill) const =0
	Kill an existing timer.

Protected Member Functions
	TimerServiceIfc () noexcept=default
	TimerServiceIfc (TimerServiceIfc const &) noexcept=delete
	TimerServiceIfc (TimerServiceIfc &&) noexcept=delete
	~TimerServiceIfc () noexcept=default
TimerServiceIfc &	operator= (TimerServiceIfc const &) &noexcept=delete
TimerServiceIfc &	operator= (TimerServiceIfc &&) &noexcept=delete

Detailed Description

Interface to start timer.

This interface does not provide ownership on the service object.

Definition at line 52 of file TimerServiceIfc.h.

Constructor & Destructor Documentation

TimerServiceIfc() [1/3]

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

protecteddefaultnoexcept

TimerServiceIfc() [2/3]

imt::base::dff::runtime::TimerServiceIfc::TimerServiceIfc ( TimerServiceIfc const &  )

protecteddeletenoexcept

TimerServiceIfc() [3/3]

imt::base::dff::runtime::TimerServiceIfc::TimerServiceIfc ( TimerServiceIfc &&  )

protecteddeletenoexcept

~TimerServiceIfc()

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

protecteddefaultnoexcept

Member Function Documentation

killTimer()

virtual RuntimeTimer::TimerHandle 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.

Returns

Updated timer handle.

operator=() [1/2]

TimerServiceIfc & imt::base::dff::runtime::TimerServiceIfc::operator= ( TimerServiceIfc &&  ) &

protecteddeletenoexcept

operator=() [2/2]

TimerServiceIfc & imt::base::dff::runtime::TimerServiceIfc::operator= ( TimerServiceIfc const &  ) &

protecteddeletenoexcept

startOneShotTimer()

virtual RuntimeTimer::TimerHandle 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).

Returns

Updated timer handle.

startPeriodicTimer()

virtual RuntimeTimer::TimerHandle 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.

Returns

Updated timer handle.

---

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

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