クラス OpenRTM_aist.Timer.Timer

Timerクラス. [詳細]

すべてのメンバ一覧

構成

class  Task
 タスク管理用クラス [詳細]

Public メソッド

def __init__
 コンストラクタ
def __del__
def run
 Timer 用のスレッド実行関数.
def start
 Timer タスク開始.
def stop
 Timer タスク停止.
def invoke
 Timer タスク実行.
def registerListener
 リスナー登録
def registerListenerObj
 リスナー登録
def registerListenerFunc
 リスナー登録
def unregisterListener
 リスナー登録解除

説明

Timerクラス.

登録されたリスナーのコールバック関数を、設定された周期で定期的に呼び出す。

から:
0.4.0

メソッド

def OpenRTM_aist.Timer.Timer.__del__ (   self  ) 

デストラクタ

def OpenRTM_aist.Timer.Timer.__init__ (   self,
  interval 
)

コンストラクタ

コンストラクタ

引数:
self 
interval タイマ起動周期
def OpenRTM_aist.Timer.Timer.invoke (   self  ) 

Timer タスク実行.

引数:
self 登録された各リスナの起動待ち時間からタイマ起動周期を減算する。 起動待ち時間がゼロとなったリスナが存在する場合は、 コールバック関数を呼び出す。
def OpenRTM_aist.Timer.Timer.registerListener (   self,
  listener,
  tm 
)

リスナー登録

Timer から起動するコールバック関数用のリスナーを起動周期を指定して 登録する。 同一リスナーが既に登録済みの場合は、リスナーの起動周期を指定した値に 更新する。

引数:
self 
listener 登録対象リスナー
tm リスナー起動周期
戻り値:
登録リスナー

ListenerId registerListener(ListenerBase* listener, TimeValue tm);

def OpenRTM_aist.Timer.Timer.registerListenerFunc (   self,
  cbf,
  tm 
)

リスナー登録

コールバック対象メソッドと起動周期を指定してリスナーを登録する。

引数:
self 
cbf コールバック対象メソッド
tm リスナー起動周期
戻り値:
登録リスナー

ListenerId registerListenerFunc(void (*cbf)(), TimeValue tm)

def OpenRTM_aist.Timer.Timer.registerListenerObj (   self,
  obj,
  cbf,
  tm 
)

リスナー登録

コールバック対象オブジェクト、コールバック対象メソッドおよび起動周期を 指定してリスナーを登録する。

引数:
self 
obj コールバック対象オブジェクト
cbf コールバック対象メソッド
tm リスナー起動周期
戻り値:
登録リスナー

template <class listenerclass>=""> ListenerId registerListenerObj(ListenerClass* obj, void (ListenerClass::*cbf)(), TimeValue tm)

def OpenRTM_aist.Timer.Timer.run (   self  ) 

Timer 用のスレッド実行関数.

Timer 用のスレッド実行関数。 登録されたリスナーのコールバック関数を呼び出す。

戻り値:
実行結果
def OpenRTM_aist.Timer.Timer.start (   self  ) 

Timer タスク開始.

Timer 用新規スレッドを生成し、処理を開始する。

引数:
self Start Timer task Create a new theread for Timer and start processing.
def OpenRTM_aist.Timer.Timer.stop (   self  ) 

Timer タスク停止.

引数:
self Timer タスクを停止する。
def OpenRTM_aist.Timer.Timer.unregisterListener (   self,
  id 
)

リスナー登録解除

指定したIDのリスナーの登録を解除する。 指定したIDのリスナーが未登録の場合、false を返す。

引数:
self 
id 登録解除対象リスナーID
戻り値:
登録解除結果

bool unregisterListener(ListenerId id);


このクラスの説明は次のファイルから生成されました:
OpenRTM-aist-1.1.0-Pythonに対してMon Mar 2 14:14:09 2015に生成されました。  doxygen 1.6.3