coil::PeriodicTask Class Reference

#include <PeriodicTask.h>

Inheritance diagram for coil::PeriodicTask:

coil::PeriodicTaskBase coil::Task

List of all members.

Public Types

typedef coil::Guard< coil::MutexGuard

Public Member Functions

 PeriodicTask ()
 ctor
virtual ~PeriodicTask ()
 dtor
virtual void activate ()
 Starting the task.
virtual void finalize ()
 Finalizing the task.
virtual int suspend (void)
 Suspending the task.
virtual int resume (void)
 Resuming the suspended task.
virtual void signal ()
 Executing the suspended task one tick.
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)
virtual void setPeriod (double period)
 Setting task execution period.
virtual void setPeriod (TimeValue &period)
 Setting task execution period.
virtual void executionMeasure (bool value)
virtual void executionMeasureCount (int n)
virtual void periodicMeasure (bool value)
virtual void periodicMeasureCount (int n)
virtual TimeMeasure::Statistics getExecStat ()
virtual TimeMeasure::Statistics getPeriodStat ()

Protected Member Functions

virtual int svc ()
virtual void sleep ()
virtual void updateExecStat ()
virtual void updatePeriodStat ()

Protected Attributes

coil::TimeValue m_period
bool m_nowait
TaskFuncBasem_func
bool m_deleteInDtor
alive_t m_alive
suspend_t m_suspend
bool m_execMeasure
unsigned int m_execCount
unsigned int m_execCountMax
statistics_t m_execStat
coil::TimeMeasure m_execTime
bool m_periodMeasure
unsigned int m_periodCount
unsigned int m_periodCountMax
statistics_t m_periodStat
coil::TimeMeasure m_periodTime

Classes

class  alive_t
struct  statistics_t
struct  suspend_t


Member Typedef Documentation


Constructor & Destructor Documentation

coil::PeriodicTask::PeriodicTask (  ) 

ctor

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

dtor


Member Function Documentation

virtual 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.

Returns:
true: normal start, false: already started or task is not set

Implements coil::PeriodicTaskBase.

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

Finalizing the task.

Finalizing the task running.

Implements coil::PeriodicTaskBase.

virtual int coil::PeriodicTask::suspend ( void   )  [virtual]

Suspending the task.

Suspending the task running.

Implements coil::PeriodicTaskBase.

virtual int coil::PeriodicTask::resume ( void   )  [virtual]

Resuming the suspended task.

Resuming the suspended task

Implements coil::PeriodicTaskBase.

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

Executing the suspended task one tick.

Executing the suspended task one tick

Implements coil::PeriodicTaskBase.

virtual bool coil::PeriodicTask::setTask ( TaskFuncBase func,
bool  delete_in_dtor = true 
) [virtual]

Setting task execution function.

Parameters:
func Set int (*)() type function pointer

Implements coil::PeriodicTaskBase.

Referenced by setTask().

template<class O, class F>
bool coil::PeriodicTask::setTask ( O *  obj,
fun 
) [inline]

Reimplemented from coil::PeriodicTaskBase.

References setTask().

virtual void coil::PeriodicTask::setPeriod ( double  period  )  [virtual]

Setting task execution period.

Parameters:
period Execution period [sec]

Implements coil::PeriodicTaskBase.

virtual void coil::PeriodicTask::setPeriod ( TimeValue period  )  [virtual]

Setting task execution period.

Parameters:
period Execution period

Implements coil::PeriodicTaskBase.

virtual void coil::PeriodicTask::executionMeasure ( bool  value  )  [virtual]

virtual void coil::PeriodicTask::executionMeasureCount ( int  n  )  [virtual]

virtual void coil::PeriodicTask::periodicMeasure ( bool  value  )  [virtual]

virtual void coil::PeriodicTask::periodicMeasureCount ( int  n  )  [virtual]

virtual TimeMeasure::Statistics coil::PeriodicTask::getExecStat (  )  [virtual]

virtual TimeMeasure::Statistics coil::PeriodicTask::getPeriodStat (  )  [virtual]

virtual int coil::PeriodicTask::svc (  )  [protected, virtual]

Reimplemented from coil::Task.

virtual void coil::PeriodicTask::sleep (  )  [protected, virtual]

virtual void coil::PeriodicTask::updateExecStat (  )  [protected, virtual]

virtual void coil::PeriodicTask::updatePeriodStat (  )  [protected, virtual]


Member Data Documentation

bool coil::PeriodicTask::m_nowait [protected]

unsigned int coil::PeriodicTask::m_execCount [protected]

unsigned int coil::PeriodicTask::m_execCountMax [protected]

unsigned int coil::PeriodicTask::m_periodCount [protected]

unsigned int coil::PeriodicTask::m_periodCountMax [protected]


Generated on Thu Jan 28 13:25:35 2010 for OpenRTM by  doxygen 1.5.5