OpenRTM-aist-Python 1.1.2
クラス | 公開メンバ関数 | 全メンバ一覧
OpenRTM_aist.Timer.Timer クラス

Timerクラス [詳解]

クラス

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

公開メンバ関数

def __init__ (self, interval)
 コンストラクタ [詳解]
 
def __del__ (self)
 デストラクタ [詳解]
 
def run (self)
 Timer 用のスレッド実行関数 [詳解]
 
def start (self)
 Timer タスク開始 [詳解]
 
def stop (self)
 Timer タスク停止 [詳解]
 
def invoke (self)
 Timer タスク実行 [詳解]
 
def registerListener (self, listener, tm)
 リスナー登録 [詳解]
 
def registerListenerObj (self, obj, cbf, tm)
 リスナー登録 [詳解]
 
def registerListenerFunc (self, cbf, tm)
 リスナー登録 [詳解]
 
def unregisterListener (self, id)
 リスナー登録解除 [詳解]
 

詳解

Timerクラス

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

から
0.4.0

構築子と解体子

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

コンストラクタ

コンストラクタ

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

デストラクタ

デストラクタ

メソッド詳解

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 用新規スレッドを生成し、処理を開始する。

引数
selfStart Timer task

Create a new theread for Timer and start processing.

def OpenRTM_aist.Timer.Timer.stop (   self)

Timer タスク停止

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

リスナー登録解除

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

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

bool unregisterListener(ListenerId id);


このクラス詳解は次のファイルから抽出されました: