Public Member Functions | List of all members
coil::PeriodicTaskBase Class Referenceabstract

PeriodicTaskBase class. More...

#include <PeriodicTaskBase.h>

Inheritance diagram for coil::PeriodicTaskBase:
Inheritance graph
[legend]

Public Member Functions

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

Additional Inherited Members

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

Detailed Description

PeriodicTaskBase class.

Definition at line 193 of file PeriodicTaskBase.h.

Constructor & Destructor Documentation

◆ ~PeriodicTaskBase()

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

Destructor.

Destructor

Definition at line 212 of file PeriodicTaskBase.h.

Member Function Documentation

◆ activate()

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.

◆ executionMeasure()

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.

◆ executionMeasureCount()

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.

◆ finalize()

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.

◆ getExecStat()

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.

◆ getPeriodStat()

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.

◆ periodicMeasure()

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.

◆ periodicMeasureCount()

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.

◆ resume()

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.

◆ setPeriod() [1/2]

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.

◆ setPeriod() [2/2]

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.

◆ setTask() [1/2]

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.

◆ setTask() [2/2]

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

Definition at line 348 of file PeriodicTaskBase.h.

◆ signal()

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.

◆ suspend()

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.


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


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Mon Feb 28 2022 23:00:46