クラス OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext
PeriodicExecutionContext クラス. [詳細]
構成 | |
| class | WorkerThreadCtrl |
| worker 用状態変数クラス [詳細] | |
Public メソッド | |
| def | __init__ |
| コンストラクタ | |
| def | svc |
| コンポーネントのアクティビティスレッド関数 | |
| def | open |
| ExecutionContext用アクティビティスレッドを生成する. | |
| def | close |
| ExecutionContext 用のスレッド実行関数. | |
| def | is_running |
| ExecutionContext 実行状態確認関数. | |
| def | start |
| ExecutionContext の実行を開始. | |
| def | stop |
| ExecutionContext の実行を停止. | |
| def | get_rate |
| ExecutionContext の実行周期(Hz)を取得する. | |
| def | set_rate |
| ExecutionContext の実行周期(Hz)を設定する. | |
| def | activate_component |
| RTコンポーネントをアクティブ化する. | |
| def | deactivate_component |
| RTコンポーネントを非アクティブ化する. | |
| def | reset_component |
| RTコンポーネントをリセットする. | |
| def | get_component_state |
| RTコンポーネントの状態を取得する. | |
| def | get_kind |
| ExecutionKind を取得する. | |
| def | add_component |
| RTコンポーネントを追加する. | |
| def | remove_component |
| RTコンポーネントを参加者リストから削除する. | |
| def | get_profile |
| ExecutionContextProfile を取得する. | |
説明
Periodic Sampled Data Processing(周期実行用)ExecutionContextクラス。
- から:
- 0.4.0
メソッド
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.__init__ | ( | self | ) |
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.activate_component | ( | self, | ||
| comp | ||||
| ) |
RTコンポーネントをアクティブ化する.
Inactive 状態にあるRTコンポーネントをActive に遷移させ、アクティブ化する。 この操作が呼ばれた結果、 on_activate が呼び出される。 指定したRTコンポーネントが参加者リストに含まれない場合は、 BAD_PARAMETER が返される。 指定したRTコンポーネントの状態が Inactive 以外の場合は、 PRECONDITION_NOT_MET が返される。
- 引数:
-
self comp アクティブ化対象RTコンポーネント
- 戻り値:
- ReturnCode_t 型のリターンコード
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.add_component | ( | self, | ||
| comp | ||||
| ) |
RTコンポーネントを追加する.
指定したRTコンポーネントを参加者リストに追加する。 追加されたRTコンポーネントは attach_context が呼ばれ、Inactive 状態に遷移 する。 指定されたRTコンポーネントがnullの場合は、BAD_PARAMETER が返される。 指定されたRTコンポーネントが DataFlowComponent 以外の場合は、 BAD_PARAMETER が返される。
- 引数:
-
self comp 追加対象RTコンポーネント
- 戻り値:
- ReturnCode_t 型のリターンコード
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.close | ( | self, | ||
| flags | ||||
| ) |
ExecutionContext 用のスレッド実行関数.
ExecutionContext 用のスレッド終了時に呼ばれる。 コンポーネントオブジェクトの非アクティブ化、マネージャへの通知を行う。 これは ACE_Task サービスクラスメソッドのオーバーライド。
- 引数:
-
self flags 終了処理フラグ
- 戻り値:
- 終了処理結果
OpenRTM_aist.Task.Taskを再定義しています。
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.deactivate_component | ( | self, | ||
| comp | ||||
| ) |
RTコンポーネントを非アクティブ化する.
Inactive 状態にあるRTコンポーネントを非アクティブ化し、 Inactive に遷移させる。 この操作が呼ばれた結果、 on_deactivate が呼び出される。 指定したRTコンポーネントが参加者リストに含まれない場合は、 BAD_PARAMETER が返される。 指定したRTコンポーネントの状態が Active 以外の場合は、 PRECONDITION_NOT_MET が返される。
- 引数:
-
self comp 非アクティブ化対象RTコンポーネント
- 戻り値:
- ReturnCode_t 型のリターンコード
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.get_component_state | ( | self, | ||
| comp | ||||
| ) |
RTコンポーネントの状態を取得する.
指定したRTコンポーネントの状態(LifeCycleState)を取得する。 指定したRTコンポーネントが参加者リストに含まれない場合は、 CREATED_STATE が返される。
- 引数:
-
self comp 状態取得対象RTコンポーネント
- 戻り値:
- 現在の状態(LifeCycleState)
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.get_kind | ( | self | ) |
ExecutionKind を取得する.
本 ExecutionContext の ExecutionKind を取得する
- 引数:
-
self
- 戻り値:
- ExecutionKind
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.get_profile | ( | self | ) |
ExecutionContextProfile を取得する.
本 ExecutionContext のプロファイルを取得する。
- 引数:
-
self
- 戻り値:
- ExecutionContextProfile
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.get_rate | ( | self | ) |
ExecutionContext の実行周期(Hz)を取得する.
Active 状態にてRTコンポーネントが実行される周期(単位:Hz)を取得する。
- 引数:
-
self
- 戻り値:
- 処理周期(単位:Hz)
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.is_running | ( | self | ) |
ExecutionContext 実行状態確認関数.
この操作は ExecutionContext が Runnning 状態の場合に true を返す。 Executioncontext が Running の間、当該 Executioncontext に参加している 全てのアクティブRTコンポーネントが、 ExecutionContext の実行種類に応じて 実行される。
- 引数:
-
self
- 戻り値:
- 状態確認関数(動作中:true、停止中:false)
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.open | ( | self, | ||
| args | ||||
| ) |
ExecutionContext用アクティビティスレッドを生成する.
int PeriodicExecutionContext.open(void *args)
OpenRTM_aist.Task.Taskを再定義しています。
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.remove_component | ( | self, | ||
| comp | ||||
| ) |
RTコンポーネントを参加者リストから削除する.
指定したRTコンポーネントを参加者リストから削除する。 削除されたRTコンポーネントは detach_context が呼ばれる。 指定されたRTコンポーネントが参加者リストに登録されていない場合は、 BAD_PARAMETER が返される。
- 引数:
-
self comp 削除対象RTコンポーネント
- 戻り値:
- ReturnCode_t 型のリターンコード
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.reset_component | ( | self, | ||
| comp | ||||
| ) |
RTコンポーネントをリセットする.
Error 状態のRTコンポーネントの復帰を試みる。 この操作が呼ばれた結果、 on_reset が呼び出される。 指定したRTコンポーネントが参加者リストに含まれない場合は、 BAD_PARAMETER が返される。 指定したRTコンポーネントの状態が Error 以外の場合は、 PRECONDITION_NOT_MET が返される。
- 引数:
-
self comp リセット対象RTコンポーネント
- 戻り値:
- ReturnCode_t 型のリターンコード
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.set_rate | ( | self, | ||
| rate | ||||
| ) |
ExecutionContext の実行周期(Hz)を設定する.
Active 状態にてRTコンポーネントが実行される周期(単位:Hz)を設定する。 実行周期の変更は、 DataFlowComponentAction の on_rate_changed によって 各RTコンポーネントに伝達される。
- 引数:
-
self rate 処理周期(単位:Hz)
- 戻り値:
- ReturnCode_t 型のリターンコード
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.start | ( | self | ) |
ExecutionContext の実行を開始.
ExecutionContext の実行状態を Runnning とするためのリクエストを発行する。 ExecutionContext の状態が遷移すると ComponentAction.on_startup が 呼び出される。 参加しているRTコンポーネントが、初期化されるまで ExecutionContext を開始 することはできない。 ExecutionContext は複数回開始/停止を繰り返すことができる。
- 引数:
-
self
- 戻り値:
- ReturnCode_t 型のリターンコード
OpenRTM_aist.ExecutionContextBase.ExecutionContextBaseを再定義しています。
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.stop | ( | self | ) |
ExecutionContext の実行を停止.
ExecutionContext の状態を Stopped とするためのリクエストを発行する。 遷移が発生した場合は、 ComponentAction.on_shutdown が呼び出される。 参加しているRTコンポーネントが終了する前に ExecutionContext を停止する 必要がある。 ExecutionContext は複数回開始/停止を繰り返すことができる。
- 引数:
-
self
- 戻り値:
- ReturnCode_t 型のリターンコード
OpenRTM_aist.ExecutionContextBase.ExecutionContextBaseを再定義しています。
| def OpenRTM_aist.PeriodicExecutionContext.PeriodicExecutionContext.svc | ( | self | ) |
コンポーネントのアクティビティスレッド関数
コンポーネントの内部アクティビティスレッドの実行関数。 ACE_Task サービスクラスメソッドのオーバーライド。
OpenRTM_aist.Task.Taskを再定義しています。
このクラスの説明は次のファイルから生成されました:
- /var/lib/jenkins/jobs/01_openrtm-python-build-tags/workspace/OpenRTM_aist/PeriodicExecutionContext.py
