#include <PeriodicTask.h>

Inheritance diagram for coil::PeriodicTask:

Classes
class	alive_t
	alive_t class More...
struct	statistics_t
	Structure for task execution time measurement management. More...
struct	suspend_t
	Structure for task suspend management. More...
Public Types
typedef coil::Guard< coil::Mutex >	Guard
Public Member Functions
virtual void	activate ()
	Starting the task.
virtual void	executionMeasure (bool value)
	Validate a Task execute time measurement.
virtual void	executionMeasureCount (int n)
	Task execute time measurement period.
virtual void	finalize ()
	Finalizing the task.
virtual TimeMeasure::Statistics	getExecStat ()
	Get a result in task execute time measurement.
virtual TimeMeasure::Statistics	getPeriodStat ()
	Get a result in task period time measurement.
virtual void	periodicMeasure (bool value)
	Validate a Task period time measurement.
virtual void	periodicMeasureCount (int n)
	Task period time measurement count.
	PeriodicTask ()
	Constructor.
virtual int	resume (void)
	Resuming the suspended task.
virtual void	setPeriod (double period)
	Setting task execution period.
virtual void	setPeriod (TimeValue &period)
	Setting task execution period.
virtual bool	setTask (TaskFuncBase *func, bool delete_in_dtor=true)
	Setting task execution function.
template<class O , class F >
bool	setTask (O *obj, F fun)
	Setting task execution function.
virtual void	signal ()
	Executing the suspended task one tick.
virtual int	suspend (void)
	Suspending the task.
virtual	~PeriodicTask ()
	Destructor.
Protected Member Functions
virtual void	sleep ()
	Thread sleep.
virtual int	svc ()
	Thread execution for PeriodicTask.
virtual void	updateExecStat ()
	Update for execute state.
virtual void	updatePeriodStat ()
	Update for period state.
Protected Attributes
alive_t	m_alive
	Task alive flag.
bool	m_deleteInDtor
	Task execution function delete flag.
unsigned int	m_execCount
	Task execution time measurement count.
unsigned int	m_execCountMax
	Task execution time measurement max count.
bool	m_execMeasure
	Task execution time measurement flag.
statistics_t	m_execStat
	Task execution time measurement statistics.
coil::TimeMeasure	m_execTime
	Task execution time measurement infomation.
TaskFuncBase *	m_func
	Task execution function.
bool	m_nowait
	Thread sleep flag.
coil::TimeValue	m_period
	Task execution period.
unsigned int	m_periodCount
	Task periodic time measurement count.
unsigned int	m_periodCountMax
	Task periodic time measurement max count.
bool	m_periodMeasure
	Task periodic time measurement flag.
statistics_t	m_periodStat
	Task periodic time measurement statistics.
coil::TimeMeasure	m_periodTime
	Task periodic time measurement infomation.
suspend_t	m_suspend
	Task suspend infomation.

Detailed Description

PeriodicTask class.

Definition at line 61 of file PeriodicTask.h.

Member Typedef Documentation

typedef coil::Guard<coil::Mutex> coil::PeriodicTask::Guard

Definition at line 65 of file PeriodicTask.h.

Constructor & Destructor Documentation

coil::PeriodicTask::PeriodicTask ( )

Constructor.

Constructor

Definition at line 32 of file PeriodicTask.cpp.

coil::PeriodicTask::~PeriodicTask ( ) [virtual]

Destructor.

Destructor

Definition at line 48 of file PeriodicTask.cpp.

Member Function Documentation

void coil::PeriodicTask::activate ( ) [virtual]

Starting the task.

Starting a thread to execute a task. If the task/thread is started properly, it will return 'TRUE'. if the task/thread are already started or task function object is not set, 'FALSE' will be returned.