OpenRTM  1.0.0
Public Member Functions | List of all members
coil::PeriodicTaskBase Class Reference

PeriodicTaskBase class. More...

#include <PeriodicTaskBase.h>

Inheritance diagram for coil::PeriodicTaskBase:
coil::Task coil::PeriodicTask

Public Member Functions

virtual ~PeriodicTaskBase ()
 Destructor.
virtual void activate ()=0
 Starting the task.
virtual void finalize ()=0
 Finalizing the task.
virtual int suspend (void)=0
 Suspending the task.
virtual int resume (void)=0
 Resuming the suspended task.
virtual void signal ()=0
 Executing the suspended task one tick.
virtual bool setTask (TaskFuncBase *func, bool delete_in_dtor=true)=0
 Setting task execution function.
template<class O , class F >
bool setTask (O *obj, F fun)
 Setting task execution function.
virtual void setPeriod (double period)=0
 Setting task execution period.
virtual void setPeriod (coil::TimeValue &period)=0
 Setting task execution period.
virtual void executionMeasure (bool value)=0
 Validate a Task execute time measurement.
virtual void executionMeasureCount (int n)=0
 Task execute time measurement period.
virtual void periodicMeasure (bool value)=0
 Validate a Task period time measurement.
virtual void periodicMeasureCount (int n)=0
 Task period time measurement count.
virtual
coil::TimeMeasure::Statistics 
getExecStat ()=0
 Get a result in task execute time measurement.
virtual
coil::TimeMeasure::Statistics 
getPeriodStat ()=0
 Get a result in task period time measurement.
- Public Member Functions inherited from coil::Task
 Task ()
 Constructor.
virtual ~Task ()
 Destructor.
virtual int open (void *args=0)
 Task open.
virtual int close (unsigned long flags=0)
 Task close.
virtual int svc ()
 Execute thread.
virtual int wait (void)
 Waiting for the thread terminate.
virtual void reset ()
 Reset of task count.

Additional Inherited Members

- Static Public Member Functions inherited from coil::Task
static void * svc_run (void *args=0)
 Start thread Execution.

Detailed Description

PeriodicTaskBase class.

Constructor & Destructor Documentation

virtual coil::PeriodicTaskBase::~PeriodicTaskBase ( )
inlinevirtual

Destructor.

Destructor

Member Function Documentation

virtual void coil::PeriodicTaskBase::activate ( )
pure virtual

Starting the task.

Pure virtual function for starting the task.

Reimplemented from coil::Task.

Implemented in coil::PeriodicTask.

virtual void coil::PeriodicTaskBase::executionMeasure ( bool  value)
pure virtual

Validate a Task execute time measurement.

Pure virtual function for validate a Task execute time measurement.

Parameters
valueflag(true: Valid, false: Invalid).

Implemented in coil::PeriodicTask.

virtual void coil::PeriodicTaskBase::executionMeasureCount ( int  n)
pure virtual

Task execute time measurement period.

Pure virtual function for task execute time measurement period.

Parameters
nMeasurement period.

Implemented in coil::PeriodicTask.

virtual void coil::PeriodicTaskBase::finalize ( )
pure virtual

Finalizing the task.

Pure virtual function for finalizing the task.

Reimplemented from coil::Task.

Implemented in coil::PeriodicTask.

virtual coil::TimeMeasure::Statistics coil::PeriodicTaskBase::getExecStat ( )
pure virtual

Get a result in task execute time measurement.

Pure virtual function for get a result in task execute time measurement.

Implemented in coil::PeriodicTask.

virtual coil::TimeMeasure::Statistics coil::PeriodicTaskBase::getPeriodStat ( )
pure virtual

Get a result in task period time measurement.

Pure virtual function for get a result in task period time measurement.

Implemented in coil::PeriodicTask.

virtual void coil::PeriodicTaskBase::periodicMeasure ( bool  value)
pure virtual

Validate a Task period time measurement.

Pure virtual function for validate a Task period time measurement.

Parameters
valueflag(true: Valid, false: Invalid).

Implemented in coil::PeriodicTask.

virtual void coil::PeriodicTaskBase::periodicMeasureCount ( int  n)
pure virtual

Task period time measurement count.

Pure virtual function for task period time measurement count.

Parameters
nMeasurement period.

Implemented in coil::PeriodicTask.

virtual int coil::PeriodicTaskBase::resume ( void  )
pure virtual

Resuming the suspended task.

Pure virtual function for resuming the suspended task.

Reimplemented from coil::Task.

Implemented in coil::PeriodicTask.

virtual void coil::PeriodicTaskBase::setPeriod ( double  period)
pure virtual

Setting task execution period.

Pure virtual function for setting task execution period.

Parameters
periodExecution period.

Implemented in coil::PeriodicTask.

virtual void coil::PeriodicTaskBase::setPeriod ( coil::TimeValue period)
pure virtual

Setting task execution period.

Pure virtual function for setting task execution period.

Parameters
periodExecution period.

Implemented in coil::PeriodicTask.

virtual bool coil::PeriodicTaskBase::setTask ( TaskFuncBase func,
bool  delete_in_dtor = true 
)
pure virtual

Setting task execution function.

Pure virtual function for setting task execution function.

Parameters
funcFunction.
delete_in_dtorDelete flag.

Implemented in coil::PeriodicTask.

Referenced by setTask().

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

Setting task execution function.

Pure virtual function for setting task execution function.

Parameters
objObject.
funFunction.
Returns
true: successful, false: failed

Reimplemented in coil::PeriodicTask.

References setTask().

virtual void coil::PeriodicTaskBase::signal ( )
pure virtual

Executing the suspended task one tick.

Pure virtual function for executing the suspended task one tick.

Implemented in coil::PeriodicTask.

virtual int coil::PeriodicTaskBase::suspend ( void  )
pure virtual

Suspending the task.

Pure virtual function for suspending the task.

Reimplemented from coil::Task.

Implemented in coil::PeriodicTask.