OpenRTM  1.0.0
公開メンバ関数 | 公開変数類 | 全メンバ一覧
RTC::PeriodicExecutionContext::DFP< Object > クラステンプレート

DFP クラス [詳解]

#include <PeriodicExecutionContext.h>

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

公開メンバ関数

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

公開変数類

Object m_obj
 管理対象コンポーネント [詳解]
 
bool m_active
 管理対象コンポーネントの動作状態フラグ [詳解]
 
- 基底クラス RTC::PeriodicExecutionContext::DFPBase に属する継承公開変数類
ExecutionContextHandle_t ec_id
 参加している ExecutionContext の ID [詳解]
 
RTC_Utils::StateMachine< ExecContextState, DFPBasem_sm
 管理対象RTコンポーネントのステートマシン [詳解]
 

詳解

template<class Object>
class RTC::PeriodicExecutionContext::DFP< Object >

DFP クラス

参加者リストに登録された DataFlowParticipant の関数を起動するための テンプレートクラス。

引数
Object管理対象コンポーネントの型
から
0.4.0

構築子と解体子

◆ DFP()

template<class Object>
RTC::PeriodicExecutionContext::DFP< Object >::DFP ( Object  obj,
ExecutionContextHandle_t  id 
)
inline

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

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

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

関数詳解

◆ on_aborting()

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_aborting ( const ECStates st)
inlinevirtual

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

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

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

RTC::PeriodicExecutionContext::DFPBaseを実装しています。

◆ on_activated()

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_activated ( const ECStates st)
inlinevirtual

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

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

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

RTC::PeriodicExecutionContext::DFPBaseを実装しています。

◆ on_deactivated()

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_deactivated ( const ECStates st)
inlinevirtual

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

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

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

RTC::PeriodicExecutionContext::DFPBaseを実装しています。

◆ on_error()

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_error ( const ECStates st)
inlinevirtual

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

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

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

RTC::PeriodicExecutionContext::DFPBaseを実装しています。

◆ on_execute()

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_execute ( const ECStates st)
inlinevirtual

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

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

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

RTC::PeriodicExecutionContext::DFPBaseを実装しています。

◆ on_rate_changed()

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_rate_changed ( void  )
inlinevirtual

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

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

RTC::PeriodicExecutionContext::DFPBaseを実装しています。

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

◆ on_reset()

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_reset ( const ECStates st)
inlinevirtual

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

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

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

RTC::PeriodicExecutionContext::DFPBaseを実装しています。

◆ on_shutdown()

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_shutdown ( void  )
inlinevirtual

ExecutionContext 停止時に呼ばれる関数

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

RTC::PeriodicExecutionContext::DFPBaseを実装しています。

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

◆ on_startup()

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_startup ( void  )
inlinevirtual

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

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

RTC::PeriodicExecutionContext::DFPBaseを実装しています。

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

◆ on_state_update()

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_state_update ( const ECStates st)
inlinevirtual

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

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

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

RTC::PeriodicExecutionContext::DFPBaseを実装しています。

メンバ詳解

◆ m_active

template<class Object>
bool RTC::PeriodicExecutionContext::DFP< Object >::m_active

管理対象コンポーネントの動作状態フラグ

◆ m_obj

template<class Object>
Object RTC::PeriodicExecutionContext::DFP< Object >::m_obj

管理対象コンポーネント

参照元 RTC::PeriodicExecutionContext::Comp::operator=().