クラス RTC::ExtTrigExecutionContext

ステップ実行が可能な ExecutionContext クラス [詳細]

#include <ExtTrigExecutionContext.h>

RTC::ExtTrigExecutionContextに対する継承グラフ
RTC::ExecutionContextBase coil::Task

すべてのメンバ一覧

構成

struct  Worker
 worker 用状態変数クラス

Public メソッド

 ExtTrigExecutionContext ()
virtual ~ExtTrigExecutionContext (void)
virtual int open (void *args)
 ExecutionContext用アクティビティスレッドを生成する.
virtual int svc (void)
 各 Component の処理を呼び出す。
virtual int close (unsigned long flags)
 ExecutionContext 用のスレッド実行関数.
virtual void tick () throw (CORBA::SystemException)
 処理を1ステップ進める
virtual CORBA::Boolean is_running (void) throw (CORBA::SystemException)
 ExecutionContext 実行状態確認関数.
virtual RTC::ReturnCode_t start (void) throw (CORBA::SystemException)
 ExecutionContext の実行を開始.
virtual RTC::ReturnCode_t stop (void) throw (CORBA::SystemException)
 ExecutionContext の実行を停止.
virtual CORBA::Double get_rate (void) throw (CORBA::SystemException)
 ExecutionContext の実行周期(Hz)を取得する.
virtual RTC::ReturnCode_t set_rate (CORBA::Double rate) throw (CORBA::SystemException)
 ExecutionContext の実行周期(Hz)を設定する.
virtual RTC::ReturnCode_t activate_component (RTC::LightweightRTObject_ptr comp) throw (CORBA::SystemException)
 RTコンポーネントをアクティブ化する.
virtual RTC::ReturnCode_t deactivate_component (RTC::LightweightRTObject_ptr comp) throw (CORBA::SystemException)
 RTコンポーネントを非アクティブ化する.
virtual RTC::ReturnCode_t reset_component (RTC::LightweightRTObject_ptr comp) throw (CORBA::SystemException)
 RTコンポーネントをリセットする.
virtual RTC::LifeCycleState get_component_state (RTC::LightweightRTObject_ptr comp) throw (CORBA::SystemException)
 RTコンポーネントの状態を取得する.
virtual RTC::ExecutionKind get_kind (void) throw (CORBA::SystemException)
 ExecutionKind を取得する.
virtual RTC::ReturnCode_t add_component (RTC::LightweightRTObject_ptr comp) throw (CORBA::SystemException)
 RTコンポーネントを追加する.
virtual RTC::ReturnCode_t remove_component (RTC::LightweightRTObject_ptr comp) throw (CORBA::SystemException)
 RTコンポーネントを参加者リストから削除する.
virtual
RTC::ExecutionContextProfile * 
get_profile (void) throw (CORBA::SystemException)
 ExecutionContextProfile を取得する.

Protected メソッド

virtual RTC::ReturnCode_t onStarted ()
 onStarted() template function
virtual RTC::ReturnCode_t onWaitingActivated (RTC_impl::RTObjectStateMachine *comp, long int count)
 onWaitingActivated() template function
virtual RTC::ReturnCode_t onWaitingDeactivated (RTC_impl::RTObjectStateMachine *comp, long int count)
 onWaitingDeactivated() template function
virtual RTC::ReturnCode_t onWaitingReset (RTC_impl::RTObjectStateMachine *comp, long int count)
 onWaitingReset() template function

説明

ステップ実行が可能な ExecutionContext クラス

1周期毎の実行が可能なPeriodic Sampled Data Processing(周期実行用) ExecutionContextクラス。 外部からのメソッド呼びだしによって時間が1周期づつ進む。

から:
0.4.0

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

RTC::ExtTrigExecutionContext::ExtTrigExecutionContext (  ) 

コンストラクタ

virtual RTC::ExtTrigExecutionContext::~ExtTrigExecutionContext ( void   )  [virtual]

デストラクタ


関数

virtual RTC::ReturnCode_t RTC::ExtTrigExecutionContext::activate_component ( RTC::LightweightRTObject_ptr  comp  )  throw (CORBA::SystemException) [virtual]

RTコンポーネントをアクティブ化する.

Inactive 状態にあるRTコンポーネントをActive に遷移させ、アクティ ブ化する。この操作が呼ばれた結果、on_activate が呼び出される。指 定したRTコンポーネントが参加者リストに含まれない場合は、 BAD_PARAMETER が返される。指定したRTコンポーネントの状態が Inactive 以外の場合は、PRECONDITION_NOT_MET が返される。

引数:
comp アクティブ化対象RTコンポーネント
戻り値:
ReturnCode_t 型のリターンコード
virtual RTC::ReturnCode_t RTC::ExtTrigExecutionContext::add_component ( RTC::LightweightRTObject_ptr  comp  )  throw (CORBA::SystemException) [virtual]

RTコンポーネントを追加する.

指定したRTコンポーネントを参加者リストに追加する。追加されたRTコ ンポーネントは attach_context が呼ばれ、Inactive 状態に遷移する。 指定されたRTコンポーネントがnullの場合は、BAD_PARAMETER が返され る。指定されたRTコンポーネントが DataFlowComponent 以外の場合は、 BAD_PARAMETER が返される。

引数:
comp 追加対象RTコンポーネント
戻り値:
ReturnCode_t 型のリターンコード
virtual int RTC::ExtTrigExecutionContext::close ( unsigned long  flags  )  [virtual]

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

ExecutionContext 用のスレッド終了時に呼ばれる。コンポーネントオ ブジェクトの非アクティブ化、マネージャへの通知を行う。これは coil::Task サービスクラスメソッドのオーバーライド。

引数:
flags 終了処理フラグ
戻り値:
終了処理結果

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

virtual RTC::ReturnCode_t RTC::ExtTrigExecutionContext::deactivate_component ( RTC::LightweightRTObject_ptr  comp  )  throw (CORBA::SystemException) [virtual]

RTコンポーネントを非アクティブ化する.

Inactive 状態にあるRTコンポーネントを非アクティブ化し、Inactive に遷移させる。この操作が呼ばれた結果、on_deactivate が呼び出され る。指定したRTコンポーネントが参加者リストに含まれない場合は、 BAD_PARAMETER が返される。指定したRTコンポーネントの状態が Active 以外の場合は、PRECONDITION_NOT_MET が返される。

引数:
comp 非アクティブ化対象RTコンポーネント
戻り値:
ReturnCode_t 型のリターンコード
virtual RTC::LifeCycleState RTC::ExtTrigExecutionContext::get_component_state ( RTC::LightweightRTObject_ptr  comp  )  throw (CORBA::SystemException) [virtual]

RTコンポーネントの状態を取得する.

指定したRTコンポーネントの状態(LifeCycleState)を取得する。指定し たRTコンポーネントが参加者リストに含まれない場合は、 UNKNOWN_STATE が返される。

引数:
comp 状態取得対象RTコンポーネント
戻り値:
現在の状態(LifeCycleState)
virtual RTC::ExecutionKind RTC::ExtTrigExecutionContext::get_kind ( void   )  throw (CORBA::SystemException) [virtual]

ExecutionKind を取得する.

本 ExecutionContext の ExecutionKind を取得する

戻り値:
ExecutionKind
virtual RTC::ExecutionContextProfile* RTC::ExtTrigExecutionContext::get_profile ( void   )  throw (CORBA::SystemException) [virtual]

ExecutionContextProfile を取得する.

本 ExecutionContext のプロファイルを取得する。

戻り値:
ExecutionContextProfile
virtual CORBA::Double RTC::ExtTrigExecutionContext::get_rate ( void   )  throw (CORBA::SystemException) [virtual]

ExecutionContext の実行周期(Hz)を取得する.

Active 状態にてRTコンポーネントが実行される周期(単位:Hz)を取得す る。

戻り値:
処理周期(単位:Hz)
virtual CORBA::Boolean RTC::ExtTrigExecutionContext::is_running ( void   )  throw (CORBA::SystemException) [virtual]

ExecutionContext 実行状態確認関数.

この操作は ExecutionContext が Runnning 状態の場合に true を返す。 Executioncontext が Running の間、当該 Executioncontext に参加し ている全てのアクティブRTコンポーネントが、ExecutionContext の実 行種類に応じて実行される。

戻り値:
状態確認関数(動作中:true、停止中:false)
virtual RTC::ReturnCode_t RTC::ExtTrigExecutionContext::onStarted (  )  [protected, virtual]

onStarted() template function

RTC::ExecutionContextBaseを再定義しています。

virtual RTC::ReturnCode_t RTC::ExtTrigExecutionContext::onWaitingActivated ( RTC_impl::RTObjectStateMachine comp,
long int  count 
) [protected, virtual]

onWaitingActivated() template function

RTC::ExecutionContextBaseを再定義しています。

virtual RTC::ReturnCode_t RTC::ExtTrigExecutionContext::onWaitingDeactivated ( RTC_impl::RTObjectStateMachine comp,
long int  count 
) [protected, virtual]

onWaitingDeactivated() template function

RTC::ExecutionContextBaseを再定義しています。

virtual RTC::ReturnCode_t RTC::ExtTrigExecutionContext::onWaitingReset ( RTC_impl::RTObjectStateMachine comp,
long int  count 
) [protected, virtual]

onWaitingReset() template function

RTC::ExecutionContextBaseを再定義しています。

virtual int RTC::ExtTrigExecutionContext::open ( void *  args  )  [virtual]

ExecutionContext用アクティビティスレッドを生成する.

Executioncontext 用の内部アクティビティスレッドを生成し起動する。 これは coil::Task サービスクラスメソッドのオーバーライド。

引数:
args 通常は0
戻り値:
生成処理実行結果

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

virtual RTC::ReturnCode_t RTC::ExtTrigExecutionContext::remove_component ( RTC::LightweightRTObject_ptr  comp  )  throw (CORBA::SystemException) [virtual]

RTコンポーネントを参加者リストから削除する.

指定したRTコンポーネントを参加者リストから削除する。削除された RTコンポーネントは detach_context が呼ばれる。指定されたRTコンポー ネントが参加者リストに登録されていない場合は、BAD_PARAMETER が返 される。

引数:
comp 削除対象RTコンポーネント
戻り値:
ReturnCode_t 型のリターンコード
virtual RTC::ReturnCode_t RTC::ExtTrigExecutionContext::reset_component ( RTC::LightweightRTObject_ptr  comp  )  throw (CORBA::SystemException) [virtual]

RTコンポーネントをリセットする.

Error 状態のRTコンポーネントの復帰を試みる。この操作が呼ばれた結 果、on_reset が呼び出される。指定したRTコンポーネントが参加者リ ストに含まれない場合は、BAD_PARAMETER が返される。指定したRTコン ポーネントの状態が Error 以外の場合は、PRECONDITION_NOT_MET が返 される。

引数:
comp リセット対象RTコンポーネント
戻り値:
ReturnCode_t 型のリターンコード
virtual RTC::ReturnCode_t RTC::ExtTrigExecutionContext::set_rate ( CORBA::Double  rate  )  throw (CORBA::SystemException) [virtual]

ExecutionContext の実行周期(Hz)を設定する.

Active 状態にてRTコンポーネントが実行される周期(単位:Hz)を設定す る。実行周期の変更は、DataFlowComponentAction の on_rate_changed によって各RTコンポーネントに伝達される。

引数:
rate 処理周期(単位:Hz)
戻り値:
ReturnCode_t 型のリターンコード
virtual RTC::ReturnCode_t RTC::ExtTrigExecutionContext::start ( void   )  throw (CORBA::SystemException) [virtual]

ExecutionContext の実行を開始.

ExecutionContext の実行状態を Runnning とするためのリクエストを 発行する。ExecutionContext の状態が遷移すると ComponentAction::on_startup が呼び出される。参加しているRTコンポー ネントが、初期化されるまで ExecutionContext を開始することはでき ない。ExecutionContext は複数回開始/停止を繰り返すことができる。

戻り値:
ReturnCode_t 型のリターンコード

RTC::ExecutionContextBaseを再定義しています。

virtual RTC::ReturnCode_t RTC::ExtTrigExecutionContext::stop ( void   )  throw (CORBA::SystemException) [virtual]

ExecutionContext の実行を停止.

ExecutionContext の状態を Stopped とするためのリクエストを発行す る。遷移が発生した場合は、ComponentActionon_shutdown が呼び出 される。参加しているRTコンポーネントが終了する前に ExecutionContext を停止する必要がある。ExecutionContext は複数回 開始/停止を繰り返すことができる。

戻り値:
ReturnCode_t 型のリターンコード

RTC::ExecutionContextBaseを再定義しています。

virtual int RTC::ExtTrigExecutionContext::svc ( void   )  [virtual]

各 Component の処理を呼び出す。

ExecutionContext に attach されている各 Component の処理を呼び出す。 全 Component の処理を呼び出した後、次の呼出が発生するまで休止する。

戻り値:
処理結果

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

virtual void RTC::ExtTrigExecutionContext::tick (  )  throw (CORBA::SystemException) [virtual]

処理を1ステップ進める

ExecutionContextの処理を1周期分進める。

OpenRTMに対してSat Apr 19 14:45:31 2014に生成されました。  doxygen 1.6.3