クラス coil::PeriodicTask

#include <PeriodicTask.h>

coil::PeriodicTaskに対する継承グラフ

coil::PeriodicTaskBase coil::Task

すべてのメンバ一覧

Public 型

typedef coil::Guard< coil::MutexGuard

Public メソッド

 PeriodicTask ()
 ctor
virtual ~PeriodicTask ()
 dtor
virtual void activate ()
 タスク実行を開始する
virtual void finalize ()
 タスク実行を終了する
virtual int suspend (void)
 タスク実行を中断する
virtual int resume (void)
 中断されているタスクを再開する
virtual void signal ()
 中断されているタスクを1周期だけ実行する
virtual bool setTask (TaskFuncBase *func, bool delete_in_dtor=true)
 タスク実行関数をセットする
template<class O, class F>
bool setTask (O *obj, F fun)
virtual void setPeriod (double period)
 タスク実行周期をセットする
virtual void setPeriod (TimeValue &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 メソッド

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

Protected 変数

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

構成

class  alive_t
struct  statistics_t
struct  suspend_t


型定義


コンストラクタとデストラクタ

coil::PeriodicTask::PeriodicTask (  ) 

ctor

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

dtor


関数

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

タスク実行を開始する

タスクの実行を開始するためにスレッドをスタートさせる。 タスクが 正常に開始された場合は true が返り、すでにタスクが開始済み、また は実行するタスクが設定されていなければ false を返す。

戻り値:
true: 正常開始、false: スレッド済みかタスクが未設定である。

coil::PeriodicTaskBaseを実装しています。

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

タスク実行を終了する

実行中のタスクを終了する。

coil::PeriodicTaskBaseを実装しています。

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

タスク実行を中断する

実行中のタスクを中断する。

coil::PeriodicTaskBaseを実装しています。

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

中断されているタスクを再開する

中断されているタスクを再開する

coil::PeriodicTaskBaseを実装しています。

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

中断されているタスクを1周期だけ実行する

中断されているタスクを1周期だけ実行する

coil::PeriodicTaskBaseを実装しています。

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

タスク実行関数をセットする

引数:
func int (*)() 型の関数ポインタ

coil::PeriodicTaskBaseを実装しています。

参照元 setTask().

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

coil::PeriodicTaskBaseを再定義しています。

参照先 setTask().

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

タスク実行周期をセットする

引数:
period 実行周期 [sec]

coil::PeriodicTaskBaseを実装しています。

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

タスク実行周期をセットする

引数:
period 実行周期

coil::PeriodicTaskBaseを実装しています。

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

タスク関数実行時間計測を有効にするか

coil::PeriodicTaskBaseを実装しています。

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

タスク関数実行時間計測周期

coil::PeriodicTaskBaseを実装しています。

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

タスク周期時間計測を有効にするか

coil::PeriodicTaskBaseを実装しています。

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

タスク周期時間計測周期

coil::PeriodicTaskBaseを実装しています。

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

タスク関数実行時間計測結果を取得

coil::PeriodicTaskBaseを実装しています。

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

タスク周期時間計測結果を取得

coil::PeriodicTaskBaseを実装しています。

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

coil::Taskを再定義しています。

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

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

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


変数

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]


OpenRTMに対してThu Jan 28 13:25:27 2010に生成されました。  doxygen 1.5.5