#include <ExecutionContextWorker.h>

RTC_impl::ExecutionContextWorker 連携図

公開メンバ関数
	ExecutionContextWorker ()
	デフォルトコンストラクタ [詳解]

virtual	~ExecutionContextWorker (void)
	デストラクタ [詳解]

void	setECRef (RTC::ExecutionContextService_ptr ref)

RTC::ExecutionContextService_ptr	getECRef ()

CORBA::Boolean	isRunning (void)
	ExecutionContext 実行状態確認関数 [詳解]

RTC::ReturnCode_t	start (void)
	ExecutionContext の実行を開始 [詳解]

RTC::ReturnCode_t	stop (void)
	ExecutionContext の実行を停止 [詳解]

RTC::ReturnCode_t	startThread (void)

RTC::ReturnCode_t	stopThread (void)

RTC::ReturnCode_t	rateChanged ()
	ExecutionContext の実行周期が変更された [詳解]

RTC::ReturnCode_t	activateComponent (RTC::LightweightRTObject_ptr comp, RTObjectStateMachine *&rtobj)
	RTコンポーネントをアクティブ化する [詳解]

RTC::ReturnCode_t	waitActivateComplete (RTObjectStateMachine *&rtobj, coil::TimeValue timeout=1.0, long int cycle=1000)

RTC::ReturnCode_t	deactivateComponent (RTC::LightweightRTObject_ptr comp, RTObjectStateMachine *&rtobj)
	RTコンポーネントを非アクティブ化する [詳解]

RTC::ReturnCode_t	waitDeactivateComplete (RTObjectStateMachine *&rtobj, coil::TimeValue timeout=1.0, long int cycle=1000)

RTC::ReturnCode_t	resetComponent (RTC::LightweightRTObject_ptr com, RTObjectStateMachine *&rtobj)
	RTコンポーネントをリセットする [詳解]

RTC::ReturnCode_t	waitResetComplete (RTObjectStateMachine *&rtobj, coil::TimeValue timeout=1.0, long int cycle=1000)

RTC::LifeCycleState	getComponentState (RTC::LightweightRTObject_ptr comp)
	RTコンポーネントの状態を取得する [詳解]

const char *	getStateString (RTC::LifeCycleState state)

RTC::ReturnCode_t	addComponent (RTC::LightweightRTObject_ptr comp)
	RTコンポーネントを追加する [詳解]

RTC::ReturnCode_t	bindComponent (RTC::RTObject_impl *rtc)
	コンポーネントをバインドする。 [詳解]

RTC::ReturnCode_t	removeComponent (RTC::LightweightRTObject_ptr comp)
	RTコンポーネントを参加者リストから削除する [詳解]

RTObjectStateMachine *	findComponent (RTC::LightweightRTObject_ptr comp)

bool	isAllCurrentState (RTC::LifeCycleState state)

bool	isAllNextState (RTC::LifeCycleState state)

bool	isOneOfCurrentState (RTC::LifeCycleState state)

bool	isOneOfNextState (RTC::LifeCycleState state)

void	invokeWorker ()

void	invokeWorkerPreDo ()

void	invokeWorkerDo ()

void	invokeWorkerPostDo ()

void	updateComponentList ()
	コンポーネントリストの更新 [詳解]

限定公開型
typedef std::vector< RTC_impl::RTObjectStateMachine * >::iterator	CompItr

限定公開変数類
RTC::Logger	rtclog
	ロガーストリーム [詳解]

RTC::ExecutionContextService_var	m_ref

bool	m_running
	ExecutionContext の実行状態 true: running, false: stopped. [詳解]

std::vector< RTC_impl::RTObjectStateMachine * >	m_comps
	コンポーネントの参加者リスト [詳解]

coil::Mutex	m_mutex

std::vector< RTC_impl::RTObjectStateMachine * >	m_addedComps

coil::Mutex	m_addedMutex

std::vector< RTC_impl::RTObjectStateMachine * >	m_removedComps

coil::Mutex	m_removedMutex

詳解

ExecutionContextWorker クラス

RTCの状態マシン・プロキシクラス RTObjectStateMachine を保持・管理し、コールバックを実際にコールするためのワーカークラスインターフェースクラス。ECの実装者は、ExecutionContextBase を継承し、メンバ変数として保持されているこの ExecutionContextWorker クラスのインターフェース経由でRTObjectのコールバックをコールすることになる。

ECのオブジェクトリファレンスのセッタ・ゲッター
- void setECRef(RTC::ExecutionContextService_ptr ref);
- RTC::ExecutionContextService_ptr getECRef(); ECの具象クラス初期化時には、アクティブ化したECのオブジェクトリファレンスをsetECRef() でセットする。
ECの実行・停止関係関数
- CORBA::Boolean isRunning(void);
- RTC::ReturnCode_t start(void);
- RTC::ReturnCode_t stop(void);
RTCのアクティブ化・非アクティブ化関数
- RTC::ReturnCode_t activateComponent(RTC::LightweightRTObject_ptr comp, RTObjectStateMachine*& rtobj);
- RTC::ReturnCode_t waitActivateComplete(RTObjectStateMachine*& rtobj, coil::TimeValue timeout = 1.0, long int cycle = 1000);
- RTC::ReturnCode_t deactivateComponent(RTC::LightweightRTObject_ptr comp, * RTObjectStateMachine*& rtobj);
- RTC::ReturnCode_t waitDeactivateComplete(RTObjectStateMachine*& rtobj, coil::TimeValue timeout = 1.0, long int cycle = 1000);
- RTC::ReturnCode_t resetComponent(RTC::LightweightRTObject_ptr com, RTObjectStateMachine*& rtobj);
- RTC::ReturnCode_t waitResetComplete(RTObjectStateMachine*& rtobj, coil::TimeValue timeout = 1.0, long int cycle = 1000);
- RTC::LifeCycleState getComponentState(RTC::LightweightRTObject_ptr comp);
- const char* getStateString(RTC::LifeCycleState state)
RTC追加・削除系関数
- RTC::ReturnCode_t addComponent(RTC::LightweightRTObject_ptr comp);
- RTC::ReturnCode_t bindComponent(RTC::RTObject_impl* rtc);
- RTC::ReturnCode_t removeComponent(RTC::LightweightRTObject_ptr comp);
- RTObjectStateMachine* findComponent(RTC::LightweightRTObject_ptr comp);
状態問い合わせ系関数
Workerの駆動およびコールバック
- void invokeWorker();
- void invokeWorkerPreDo();
- void invokeWorkerDo();
- void invokeWorkerPostDo();

から: 1.2

型定義メンバ詳解

typedef std::vector<RTC_impl::RTObjectStateMachine*>::iterator RTC_impl::ExecutionContextWorker::CompItr

protected

構築子と解体子

RTC_impl::ExecutionContextWorker::ExecutionContextWorker ( )

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

デフォルトコンストラクタプロファイルに以下の項目を設定する。

kind : PERIODIC
rate : 0.0

virtual RTC_impl::ExecutionContextWorker::~ExecutionContextWorker ( void )

virtual

デストラクタ

関数詳解

RTC::ReturnCode_t RTC_impl::ExecutionContextWorker::activateComponent	(	RTC::LightweightRTObject_ptr	comp,
		RTObjectStateMachine *&	rtobj
	)

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

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

引数

comp	アクティブ化対象RTコンポーネント

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

RTC::ReturnCode_t RTC_impl::ExecutionContextWorker::addComponent ( RTC::LightweightRTObject_ptr comp )

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

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

この関数が呼ばれた段階では、他の RTC は StateMachine 内のコールバック関数を呼び出し中の可能性があり、まずは "参加者リスト: m_addedComps" に RTC を追加しておく。コールバック呼び出しが一旦終わった段階で同期的に updateComponentList() 関数が呼ばれ、この Worker に正式に RTC が参加した状態となる。

引数

comp	追加対象RTコンポーネント

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

RTC::ReturnCode_t RTC_impl::ExecutionContextWorker::bindComponent ( RTC::RTObject_impl * rtc )

コンポーネントをバインドする。

コンポーネントに owned context をバインドする。引数に渡される RTObject_impl は、この EC の owner であり、内部的には RTObject の bindContext() をコール氏、ec_idを取得する。ec_id は ECOTHER_OFFSET よりも小さい。その後、RTObject のプロキシである RTObjectStateMachine を生成し、コンポーネントのリストに加える。

引数

rtc RTコンポーネント

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

RTC::ReturnCode_t RTC_impl::ExecutionContextWorker::deactivateComponent	(	RTC::LightweightRTObject_ptr	comp,
		RTObjectStateMachine *&	rtobj
	)

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

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

引数

comp	非アクティブ化対象RTコンポーネント

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

RTObjectStateMachine* RTC_impl::ExecutionContextWorker::findComponent ( RTC::LightweightRTObject_ptr comp )

RTC::LifeCycleState RTC_impl::ExecutionContextWorker::getComponentState ( RTC::LightweightRTObject_ptr comp )

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

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

引数

comp	状態取得対象RTコンポーネント

戻り値: 現在の状態(LifeCycleState)

RTC::ExecutionContextService_ptr RTC_impl::ExecutionContextWorker::getECRef ( )

const char* RTC_impl::ExecutionContextWorker::getStateString ( RTC::LifeCycleState state )

inline

void RTC_impl::ExecutionContextWorker::invokeWorker ( )

void RTC_impl::ExecutionContextWorker::invokeWorkerDo ( )

void RTC_impl::ExecutionContextWorker::invokeWorkerPostDo ( )

void RTC_impl::ExecutionContextWorker::invokeWorkerPreDo ( )

bool RTC_impl::ExecutionContextWorker::isAllCurrentState ( RTC::LifeCycleState state )

bool RTC_impl::ExecutionContextWorker::isAllNextState ( RTC::LifeCycleState state )

bool RTC_impl::ExecutionContextWorker::isOneOfCurrentState ( RTC::LifeCycleState state )

bool RTC_impl::ExecutionContextWorker::isOneOfNextState ( RTC::LifeCycleState state )

CORBA::Boolean RTC_impl::ExecutionContextWorker::isRunning ( void )

ExecutionContext 実行状態確認関数

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

戻り値: 状態確認関数(動作中:true、停止中:false)

RTC::ReturnCode_t RTC_impl::ExecutionContextWorker::rateChanged ( )

ExecutionContext の実行周期が変更された

ExecutionContext の実行周期が変更された場合のコールバックを呼び出す。ECの実装クラスの set_rate() オペレーションが呼び出された場合、ExecutionContextProfile::setRate() が呼び出され、プロファイルの周期値が更新されるとともに、この関数が呼ばれ、 RTObjectStateMachine::onRateChagned() が呼び出される。

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

RTC::ReturnCode_t RTC_impl::ExecutionContextWorker::removeComponent ( RTC::LightweightRTObject_ptr comp )

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

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

引数

comp	削除対象RTコンポーネント

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

RTC::ReturnCode_t RTC_impl::ExecutionContextWorker::resetComponent	(	RTC::LightweightRTObject_ptr	com,
		RTObjectStateMachine *&	rtobj
	)

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

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

引数

comp	リセット対象RTコンポーネント

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

void RTC_impl::ExecutionContextWorker::setECRef ( RTC::ExecutionContextService_ptr ref )

RTC::ReturnCode_t RTC_impl::ExecutionContextWorker::start ( void )

ExecutionContext の実行を開始

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

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

RTC::ReturnCode_t RTC_impl::ExecutionContextWorker::startThread ( void )

RTC::ReturnCode_t RTC_impl::ExecutionContextWorker::stop ( void )

ExecutionContext の実行を停止

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

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

RTC::ReturnCode_t RTC_impl::ExecutionContextWorker::stopThread ( void )

void RTC_impl::ExecutionContextWorker::updateComponentList ( )

コンポーネントリストの更新

RTC::ReturnCode_t RTC_impl::ExecutionContextWorker::waitActivateComplete	(	RTObjectStateMachine *&	rtobj,
		coil::TimeValue	timeout = `1.0`,
		long int	cycle = `1000`
	)

RTC::ReturnCode_t RTC_impl::ExecutionContextWorker::waitDeactivateComplete	(	RTObjectStateMachine *&	rtobj,
		coil::TimeValue	timeout = `1.0`,
		long int	cycle = `1000`
	)

RTC::ReturnCode_t RTC_impl::ExecutionContextWorker::waitResetComplete	(	RTObjectStateMachine *&	rtobj,
		coil::TimeValue	timeout = `1.0`,
		long int	cycle = `1000`
	)

メンバ詳解

std::vector<RTC_impl::RTObjectStateMachine*> RTC_impl::ExecutionContextWorker::m_addedComps

protected

coil::Mutex RTC_impl::ExecutionContextWorker::m_addedMutex

mutableprotected

std::vector<RTC_impl::RTObjectStateMachine*> RTC_impl::ExecutionContextWorker::m_comps

protected

コンポーネントの参加者リスト

coil::Mutex RTC_impl::ExecutionContextWorker::m_mutex

mutableprotected

RTC::ExecutionContextService_var RTC_impl::ExecutionContextWorker::m_ref

protected

std::vector<RTC_impl::RTObjectStateMachine*> RTC_impl::ExecutionContextWorker::m_removedComps

protected

coil::Mutex RTC_impl::ExecutionContextWorker::m_removedMutex

mutableprotected

bool RTC_impl::ExecutionContextWorker::m_running

protected

ExecutionContext の実行状態 true: running, false: stopped.

RTC::Logger RTC_impl::ExecutionContextWorker::rtclog

protected

ロガーストリーム

このクラス詳解は次のファイルから抽出されました:

ExecutionContextWorker.h

公開メンバ関数

限定公開型

限定公開変数類

詳解

型定義メンバ詳解

構築子と解体子

関数詳解

メンバ詳解