クラス PeriodicExecutionContext::DFP

DFP クラス [詳細]


Public メソッド

def __init__
 デフォルトコンストラクタ
def on_startup
 ExecutionContext 実行開始時に呼ばれる関数
def on_shutdown
 ExecutionContext 停止時に呼ばれる関数
def on_activated
 RTコンポーネントがアクティブ化された時に呼ばれる関数
def on_deactivated
 RTコンポーネントが非アクティブ化された時に呼ばれる関数
def on_aborting
 RTコンポーネントでエラーが発生した時に呼ばれる関数
def on_error
 RTコンポーネントがエラー状態の時に呼ばれる関数
def on_reset
 RTコンポーネントをリセットする時に呼ばれる関数
def on_execute
 RTコンポーネント実行時に定期的に呼ばれる関数
def on_state_update
 RTコンポーネント実行時に定期的に呼ばれる関数
def on_rate_changed
 ExecutionContext の実行周期変更時に呼ばれる関数
def worker
 状態遷移を実行するワーカーを取得する
def get_state
 現在の状態を取得する


説明

DFP クラス

参加者リストに登録された DataFlowParticipant の関数を起動するための 内部クラス。

引数:
Object 管理対象コンポーネントの型

PeriodicExecutionContext.py58 行で定義されています。


関数

def __init__ (   self,
  obj,
  id_ 
)

デフォルトコンストラクタ

デフォルトコンストラクタ

引数:
self 
obj 管理対象コンポーネント
id_ 所属する ExecutionContext のID

PeriodicExecutionContext.py75 行で定義されています。

def on_startup (   self  ) 

ExecutionContext 実行開始時に呼ばれる関数

参加している ExecutionContext が実行を開始する時(Running状態へ遷移時) に、管理対象コンポーネントの on_startup を呼びだす。

引数:
self 

PeriodicExecutionContext.py117 行で定義されています。

def on_shutdown (   self  ) 

ExecutionContext 停止時に呼ばれる関数

参加している ExecutionContext が実行を停止する時(Stopped状態へ遷移時) に、管理対象コンポーネントの on_shutdown を呼びだす。

引数:
self 

PeriodicExecutionContext.py133 行で定義されています。

def on_activated (   self,
  st 
)

RTコンポーネントがアクティブ化された時に呼ばれる関数

管理対象のRTコンポーネントがアクティブ化された時(Active状態へ遷移時) に、管理対象コンポーネントの on_activated を呼びだす。 管理対象コンポーネントのアクティブ化が失敗した場合には、ステートマシン を Error 状態に遷移させる。

引数:
self 
st 対象RTコンポーネントの現在の状態

PeriodicExecutionContext.py152 行で定義されています。

def on_deactivated (   self,
  st 
)

RTコンポーネントが非アクティブ化された時に呼ばれる関数

管理対象のRTコンポーネントが非アクティブ化された時 (Deactive状態へ遷移時)に、管理対象コンポーネントの on_deactivated を 呼びだす。

引数:
self 
st 対象RTコンポーネントの現在の状態

PeriodicExecutionContext.py173 行で定義されています。

def on_aborting (   self,
  st 
)

RTコンポーネントでエラーが発生した時に呼ばれる関数

管理対象のRTコンポーネントにエラーが発生した時(Error状態へ遷移時) に管理対象コンポーネントの on_aborting を呼びだす。

引数:
self 
st 対象RTコンポーネントの現在の状態

PeriodicExecutionContext.py192 行で定義されています。

def on_error (   self,
  st 
)

RTコンポーネントがエラー状態の時に呼ばれる関数

管理対象のRTコンポーネントがエラー状態にいる間、 管理対象コンポーネントの on_aborting を定期的に呼びだす。

引数:
self 
st 対象RTコンポーネントの現在の状態

PeriodicExecutionContext.py211 行で定義されています。

def on_reset (   self,
  st 
)

RTコンポーネントをリセットする時に呼ばれる関数

管理対象のRTコンポーネントをリセットする際に、管理対象コンポーネント の on_reset を呼びだす。

引数:
self 
st 対象RTコンポーネントの現在の状態

PeriodicExecutionContext.py228 行で定義されています。

def on_execute (   self,
  st 
)

RTコンポーネント実行時に定期的に呼ばれる関数

管理対象のRTコンポーネントが Active 状態であるとともに、 ExecutionContext が Running 状態の場合に、設定された動作周期で定期的に 管理対象コンポーネントの on_execute を呼びだす。 関数の実行に失敗した場合(返値が RTC_OK 以外)、管理対象コンポーネントの 状態を Error 状態に遷移させる。

引数:
self 
st 対象RTコンポーネントの現在の状態

PeriodicExecutionContext.py251 行で定義されています。

def on_state_update (   self,
  st 
)

RTコンポーネント実行時に定期的に呼ばれる関数

管理対象のRTコンポーネントが Active 状態であるとともに、 ExecutionContext が Running 状態の場合に、設定された動作周期で定期的に 管理対象コンポーネントの on_state_update を呼びだす。 関数の実行に失敗した場合(返値が RTC_OK 以外)、管理対象コンポーネントの 状態を Error 状態に遷移させる。

引数:
self 
st 対象RTコンポーネントの現在の状態

PeriodicExecutionContext.py274 行で定義されています。

def on_rate_changed (   self  ) 

ExecutionContext の実行周期変更時に呼ばれる関数

参加している ExecutionContext の実行周期が変更となった場合に、 管理対象コンポーネントの on_rate_changed を呼びだす。

引数:
self 

PeriodicExecutionContext.py293 行で定義されています。

def worker (   self  ) 

状態遷移を実行するワーカーを取得する

管理対象RTコンポーネントの状態遷移を実行するワーカーを取得する。

引数:
self 
戻り値:
ワーカー

PeriodicExecutionContext.py312 行で定義されています。

def get_state (   self  ) 

現在の状態を取得する

管理対象RTコンポーネントの現在の状態を取得する。

引数:
self 
戻り値:
現在状態

PeriodicExecutionContext.py331 行で定義されています。


OpenRTMに対してMon Mar 17 15:11:07 2008に生成されました。  doxygen 1.5.4