クラス テンプレート RTC::PeriodicExecutionContext::DFP< Object >

DFP クラス. [詳細]

#include <PeriodicExecutionContext.h>

RTC::PeriodicExecutionContext::DFP< Object >に対する継承グラフ
RTC::PeriodicExecutionContext::DFPBase

すべてのメンバ一覧

Public メソッド

 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 の実行周期変更時に呼ばれる関数.

Public 変数

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

説明

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

DFP クラス.

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

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

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

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

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

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

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

関数

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_aborting ( const ECStates st  )  [inline, virtual]

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

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

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

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

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_activated ( const ECStates st  )  [inline, virtual]

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

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

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

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

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_deactivated ( const ECStates st  )  [inline, virtual]

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

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

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

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

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_error ( const ECStates st  )  [inline, virtual]

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

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

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

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

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_execute ( const ECStates st  )  [inline, virtual]

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

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

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

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

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_rate_changed ( void   )  [inline, virtual]

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

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

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

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

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_reset ( const ECStates st  )  [inline, virtual]

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

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

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

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

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_shutdown ( void   )  [inline, virtual]

ExecutionContext 停止時に呼ばれる関数.

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

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

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

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_startup ( void   )  [inline, virtual]

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

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

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

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

template<class Object>
void RTC::PeriodicExecutionContext::DFP< Object >::on_state_update ( const ECStates st  )  [inline, virtual]

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

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

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

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


変数

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

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

template<class Object>
Object RTC::PeriodicExecutionContext::DFP< Object >::m_obj
OpenRTMに対してFri Mar 11 00:00:51 2011に生成されました。  doxygen 1.6.3