OpenRTM  1.1.1
公開メンバ関数 | 公開変数類 | 全メンバ一覧
RTC::PeriodicExecutionContext::DFPBase クラスabstract

DFPBase クラス [詳解]

#include <PeriodicExecutionContext.h>

RTC::PeriodicExecutionContext::DFPBase の継承関係図
RTC::PeriodicExecutionContext::DFP< OpenRTM::DataFlowComponent_var > RTC::PeriodicExecutionContext::DFP< Object >

公開メンバ関数

 DFPBase (RTC::ExecutionContextHandle_t id)
 コンストラクタ [詳解]
 
virtual ~DFPBase (void)
 デストラクタ [詳解]
 
virtual void on_startup (void)=0
 ExecutionContext 実行開始時に呼ばれる純粋仮想関数 [詳解]
 
virtual void on_shutdown (void)=0
 ExecutionContext 停止時に呼ばれる純粋仮想関数 [詳解]
 
virtual void on_activated (const ECStates &st)=0
 RTコンポーネントがアクティブ化された時に呼ばれる純粋仮想関数 [詳解]
 
virtual void on_deactivated (const ECStates &st)=0
 RTコンポーネントが非アクティブ化された時に呼ばれる純粋仮想関数 [詳解]
 
virtual void on_aborting (const ECStates &st)=0
 RTコンポーネントでエラーが発生した時に呼ばれる純粋仮想関数 [詳解]
 
virtual void on_error (const ECStates &st)=0
 RTコンポーネントがエラー状態の時に呼ばれる純粋仮想関数 [詳解]
 
virtual void on_reset (const ECStates &st)=0
 RTコンポーネントをリセットする時に呼ばれる純粋仮想関数 [詳解]
 
virtual void on_execute (const ECStates &st)=0
 RTコンポーネント実行時に定期的に呼ばれる純粋仮想関数 [詳解]
 
virtual void on_state_update (const ECStates &st)=0
 RTコンポーネント実行時に定期的に呼ばれる純粋仮想関数 [詳解]
 
virtual void on_rate_changed (void)=0
 ExecutionContext の実行周期変更時に呼ばれる純粋仮想関数 [詳解]
 
virtual void worker (void)
 状態遷移を実行するワーカーを取得する [詳解]
 
virtual ExecContextState get_state (void)
 現在の状態を取得する [詳解]
 

公開変数類

ExecutionContextHandle_t ec_id
 参加している ExecutionContext の ID [詳解]
 
RTC_Utils::StateMachine
< ExecContextState, DFPBase
m_sm
 管理対象RTコンポーネントのステートマシン [詳解]
 

詳解

DFPBase クラス

参加者リストに登録された DataFlowParticipant を管理するための抽象クラス。

から
0.4.0

構築子と解体子

RTC::PeriodicExecutionContext::DFPBase::DFPBase ( RTC::ExecutionContextHandle_t  id)
inline
virtual RTC::PeriodicExecutionContext::DFPBase::~DFPBase ( void  )
inlinevirtual

デストラクタ

デストラクタ

関数詳解

virtual ExecContextState RTC::PeriodicExecutionContext::DFPBase::get_state ( void  )
inlinevirtual

現在の状態を取得する

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

戻り値
現在状態
virtual void RTC::PeriodicExecutionContext::DFPBase::on_aborting ( const ECStates st)
pure virtual

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

管理対象のRTコンポーネントにエラーが発生した時(Error状態へ遷移時) に呼ばれる純粋仮想関数。

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

RTC::PeriodicExecutionContext::DFP< Object >, RTC::PeriodicExecutionContext::DFP< OpenRTM::DataFlowComponent_var >で実装されています。

参照元 DFPBase().

virtual void RTC::PeriodicExecutionContext::DFPBase::on_activated ( const ECStates st)
pure virtual

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

管理対象のRTコンポーネントがアクティブ化された時 (Active状態へ遷移時)に呼ばれる純粋仮想関数。

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

RTC::PeriodicExecutionContext::DFP< Object >, RTC::PeriodicExecutionContext::DFP< OpenRTM::DataFlowComponent_var >で実装されています。

参照元 DFPBase().

virtual void RTC::PeriodicExecutionContext::DFPBase::on_deactivated ( const ECStates st)
pure virtual

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

管理対象のRTコンポーネントが非アクティブ化された時 (Deactive状態へ遷移時)に呼ばれる純粋仮想関数。

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

RTC::PeriodicExecutionContext::DFP< Object >, RTC::PeriodicExecutionContext::DFP< OpenRTM::DataFlowComponent_var >で実装されています。

参照元 DFPBase().

virtual void RTC::PeriodicExecutionContext::DFPBase::on_error ( const ECStates st)
pure virtual

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

管理対象のRTコンポーネントがエラー状態にいる間、on_execute と on_state_update に替わって定期的に呼び出される純粋仮想関数。

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

RTC::PeriodicExecutionContext::DFP< Object >, RTC::PeriodicExecutionContext::DFP< OpenRTM::DataFlowComponent_var >で実装されています。

参照元 DFPBase().

virtual void RTC::PeriodicExecutionContext::DFPBase::on_execute ( const ECStates st)
pure virtual

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

管理対象のRTコンポーネントが Active 状態であるとともに、 ExecutionContext が Running 状態の場合に、設定された動作周期で定期的に 呼び出される純粋仮想関数。 Two-Pass Execution の最初の実行で呼ばれる。

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

RTC::PeriodicExecutionContext::DFP< Object >, RTC::PeriodicExecutionContext::DFP< OpenRTM::DataFlowComponent_var >で実装されています。

参照元 DFPBase().

virtual void RTC::PeriodicExecutionContext::DFPBase::on_rate_changed ( void  )
pure virtual

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

参加している ExecutionContext の実行周期が変更となった場合に、 この変更を伝達するために呼び出される純粋仮想関数。

RTC::PeriodicExecutionContext::DFP< Object >, RTC::PeriodicExecutionContext::DFP< OpenRTM::DataFlowComponent_var >で実装されています。

virtual void RTC::PeriodicExecutionContext::DFPBase::on_reset ( const ECStates st)
pure virtual

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

管理対象のRTコンポーネントをリセットする際に呼ばれる純粋仮想関数。 この関数が正常に終了すると,RTCは Inactive 状態に復帰する。 この関数が正常に終了しなかった場合は, Error 状態に留まる。

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

RTC::PeriodicExecutionContext::DFP< Object >, RTC::PeriodicExecutionContext::DFP< OpenRTM::DataFlowComponent_var >で実装されています。

参照元 DFPBase().

virtual void RTC::PeriodicExecutionContext::DFPBase::on_shutdown ( void  )
pure virtual

ExecutionContext 停止時に呼ばれる純粋仮想関数

参加している ExecutionContext が実行を停止する時(Stopped状態へ遷移時) に呼ばれる純粋仮想関数。

RTC::PeriodicExecutionContext::DFP< Object >, RTC::PeriodicExecutionContext::DFP< OpenRTM::DataFlowComponent_var >で実装されています。

virtual void RTC::PeriodicExecutionContext::DFPBase::on_startup ( void  )
pure virtual

ExecutionContext 実行開始時に呼ばれる純粋仮想関数

参加している ExecutionContext が実行を開始する時(Running状態へ遷移時) に呼ばれる純粋仮想関数。

RTC::PeriodicExecutionContext::DFP< Object >, RTC::PeriodicExecutionContext::DFP< OpenRTM::DataFlowComponent_var >で実装されています。

virtual void RTC::PeriodicExecutionContext::DFPBase::on_state_update ( const ECStates st)
pure virtual

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

管理対象のRTコンポーネントが Active 状態であるとともに、 ExecutionContext が Running 状態の場合に、設定された動作周期で定期的に 呼び出される純粋仮想関数。 Two-Pass Execution の2番目の実行で呼ばれる。

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

RTC::PeriodicExecutionContext::DFP< Object >, RTC::PeriodicExecutionContext::DFP< OpenRTM::DataFlowComponent_var >で実装されています。

参照元 DFPBase().

virtual void RTC::PeriodicExecutionContext::DFPBase::worker ( void  )
inlinevirtual

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

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

戻り値
ワーカー

参照元 RTC::PeriodicExecutionContext::invoke_worker::operator()().

メンバ詳解

ExecutionContextHandle_t RTC::PeriodicExecutionContext::DFPBase::ec_id
RTC_Utils::StateMachine<ExecContextState, DFPBase> RTC::PeriodicExecutionContext::DFPBase::m_sm