adtf::system::kernel_timer Class Reference

#include <kernel_timer.h>

Public Member Functions
	kernel_timer ()
	kernel_timer (const kernel_timer &)=delete
	kernel_timer (kernel_timer &&)
template<typename Callable, typename ... Args>
	kernel_timer (adtf::services::IKernel::tTimerClock eClock, const adtf::services::IKernel::tSchedulingInfo &sScheduling, const char *strName, tTimeStamp tmPeriod, tTimeStamp tmInitialDelay, Callable &&pFunc, Args &&... args)
template<typename Callable, typename ... Args>
	kernel_timer (tTimeStamp tmMaximumExectionTime, adtf::services::IKernel::tTimerClock eClock, const adtf::services::IKernel::tSchedulingInfo &sScheduling, const char *strName, tTimeStamp tmPeriod, tTimeStamp tmInitialDelay, uint32_t nFlags, Callable &&pFunc, Args &&... args)
template<typename Callable, typename ... Args>
	kernel_timer (const char *strName, tTimeStamp tmPeriod, tTimeStamp tmInitialDelay, Callable &&pFunc, Args &&... args)
	~kernel_timer ()
kernel_timer &	operator= (kernel_timer &&oOther)
void	Swap (kernel_timer &oOther)
bool	Stoppable () const
tResult	Stop ()
tResult	SetScheduling (const adtf::services::IKernel::tSchedulingInfo &sScheduling)
tResult	GetScheduling (adtf::services::IKernel::tSchedulingInfo &sScheduling) const

Friends
class	cKernelTimerHelperRunnable

Detailed Description

Class that wraps a kernel timer to call a method at specified intervals.

Constructor & Destructor Documentation

kernel_timer() [1/5]

adtf::system::kernel_timer::kernel_timer

(

)

Default constructor.

kernel_timer() [2/5]

adtf::system::kernel_timer::kernel_timer

(

kernel_timer &&

)

Move constructor.

kernel_timer() [3/5]

template<typename Callable, typename ... Args>

adtf::system::kernel_timer::kernel_timer ( adtf::services::IKernel::tTimerClock eClock, const adtf::services::IKernel::tSchedulingInfo & sScheduling, const char * strName, tTimeStamp tmPeriod, tTimeStamp tmInitialDelay, Callable && pFunc, Args &&... args )

inline

Constructor that creates a new timer with a given clock and scheduling parameters.

kernel_timer() [4/5]

template<typename Callable, typename ... Args>

adtf::system::kernel_timer::kernel_timer ( tTimeStamp tmMaximumExectionTime, adtf::services::IKernel::tTimerClock eClock, const adtf::services::IKernel::tSchedulingInfo & sScheduling, const char * strName, tTimeStamp tmPeriod, tTimeStamp tmInitialDelay, uint32_t nFlags, Callable && pFunc, Args &&... args )

inline

Constructor that creates a new timer with a given clock, scheduling parameters and flags.

kernel_timer() [5/5]

template<typename Callable, typename ... Args>

adtf::system::kernel_timer::kernel_timer ( const char * strName, tTimeStamp tmPeriod, tTimeStamp tmInitialDelay, Callable && pFunc, Args &&... args )

inline

Constructor that creates a new timer.

~kernel_timer()

adtf::system::kernel_timer::~kernel_timer

(

)

Destructor. This will stop the timer.

Member Function Documentation

GetScheduling()

tResult adtf::system::kernel_timer::GetScheduling

(

adtf::services::IKernel::tSchedulingInfo &

sScheduling

)

const

Retrieves the scheduling parameters of the thread.

Parameters

[in]

sScheduling

The scheduling parameters.

Returns

Standard result.

operator=()

kernel_timer & adtf::system::kernel_timer::operator=

(

kernel_timer &&

oOther

)

Move assignment operator.

Parameters

[in,out]

oOther

The object that should be moved.

Returns

A reference to this.

SetScheduling()

tResult adtf::system::kernel_timer::SetScheduling

(

const adtf::services::IKernel::tSchedulingInfo &

sScheduling

)

Changes the scheduling parameters of the timer.

Parameters

[in]

sScheduling

The new scheduling parameters.

Returns

Standard result.

Stop()

tResult adtf::system::kernel_timer::Stop

(

)

Stop the timer. Mind that the destructor calls this method, so there is no need to call this method directly.

Returns

Standard result.

Stoppable()

bool adtf::system::kernel_timer::Stoppable

(

)

const

Whether or not the timer is stoppable, i.e. currently running.

Returns

Whether or not the timer is stoppable, i.e. currently running.

Swap()

void adtf::system::kernel_timer::Swap

(

kernel_timer &

oOther

)

Swaps two timers

Parameters

[in,out]

oOther

The second timer.

---

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

• src/libraries/systemsdk/include/adtfsystemsdk/kernel_timer.h