PeriodicTask class.
More...
#include <PeriodicTask.h>
◆ Guard
◆ PeriodicTask()
coil::PeriodicTask::PeriodicTask |
( |
| ) |
|
◆ ~PeriodicTask()
virtual coil::PeriodicTask::~PeriodicTask |
( |
| ) |
|
|
virtual |
◆ activate()
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.
◆ executionMeasure()
virtual void coil::PeriodicTask::executionMeasure |
( |
bool |
value | ) |
|
|
virtual |
◆ executionMeasureCount()
virtual void coil::PeriodicTask::executionMeasureCount |
( |
int |
n | ) |
|
|
virtual |
◆ finalize()
virtual void coil::PeriodicTask::finalize |
( |
| ) |
|
|
virtual |
◆ getExecStat()
◆ getPeriodStat()
◆ periodicMeasure()
virtual void coil::PeriodicTask::periodicMeasure |
( |
bool |
value | ) |
|
|
virtual |
◆ periodicMeasureCount()
virtual void coil::PeriodicTask::periodicMeasureCount |
( |
int |
n | ) |
|
|
virtual |
◆ resume()
virtual int coil::PeriodicTask::resume |
( |
void |
| ) |
|
|
virtual |
◆ setPeriod() [1/2]
virtual void coil::PeriodicTask::setPeriod |
( |
double |
period | ) |
|
|
virtual |
◆ setPeriod() [2/2]
virtual void coil::PeriodicTask::setPeriod |
( |
TimeValue & |
period | ) |
|
|
virtual |
◆ setTask() [1/2]
virtual bool coil::PeriodicTask::setTask |
( |
TaskFuncBase * |
func, |
|
|
bool |
delete_in_dtor = true |
|
) |
| |
|
virtual |
◆ setTask() [2/2]
template<class O , class F >
bool coil::PeriodicTask::setTask |
( |
O * |
obj, |
|
|
F |
fun |
|
) |
| |
|
inline |
Setting task execution function.
- Parameters
-
func | Set int (*)() type function pointer |
- Returns
- true: successful, false: failed
References executionMeasure(), executionMeasureCount(), getExecStat(), getPeriodStat(), periodicMeasure(), periodicMeasureCount(), setPeriod(), setTask(), sleep(), svc(), updateExecStat(), and updatePeriodStat().
◆ signal()
virtual void coil::PeriodicTask::signal |
( |
| ) |
|
|
virtual |
Executing the suspended task one tick.
Executing the suspended task one tick
Implements coil::PeriodicTaskBase.
◆ sleep()
virtual void coil::PeriodicTask::sleep |
( |
| ) |
|
|
protectedvirtual |
◆ suspend()
virtual int coil::PeriodicTask::suspend |
( |
void |
| ) |
|
|
virtual |
◆ svc()
virtual int coil::PeriodicTask::svc |
( |
| ) |
|
|
protectedvirtual |
◆ updateExecStat()
virtual void coil::PeriodicTask::updateExecStat |
( |
| ) |
|
|
protectedvirtual |
Update for execute state.
Referenced by setTask().
◆ updatePeriodStat()
virtual void coil::PeriodicTask::updatePeriodStat |
( |
| ) |
|
|
protectedvirtual |
Update for period state.
Referenced by setTask().
◆ m_alive
alive_t coil::PeriodicTask::m_alive |
|
protected |
◆ m_deleteInDtor
bool coil::PeriodicTask::m_deleteInDtor |
|
protected |
Task execution function delete flag.
◆ m_execCount
unsigned int coil::PeriodicTask::m_execCount |
|
protected |
Task execution time measurement count.
◆ m_execCountMax
unsigned int coil::PeriodicTask::m_execCountMax |
|
protected |
Task execution time measurement max count.
◆ m_execMeasure
bool coil::PeriodicTask::m_execMeasure |
|
protected |
Task execution time measurement flag.
◆ m_execStat
Task execution time measurement statistics.
◆ m_execTime
Task execution time measurement infomation.
◆ m_func
◆ m_nowait
bool coil::PeriodicTask::m_nowait |
|
protected |
◆ m_period
◆ m_periodCount
unsigned int coil::PeriodicTask::m_periodCount |
|
protected |
Task periodic time measurement count.
◆ m_periodCountMax
unsigned int coil::PeriodicTask::m_periodCountMax |
|
protected |
Task periodic time measurement max count.
◆ m_periodMeasure
bool coil::PeriodicTask::m_periodMeasure |
|
protected |
Task periodic time measurement flag.
◆ m_periodStat
Task periodic time measurement statistics.
◆ m_periodTime
Task periodic time measurement infomation.
◆ m_suspend