#include <ExecutionContextWorker.h>

RTC_impl::ExecutionContextWorker 連携図

[凡例]

公開メンバ関数
	ExecutionContextWorker ()
	デフォルトコンストラクタ
virtual	~ExecutionContextWorker ()
	デストラクタ
void	setECRef (RTC::ExecutionContextService_ptr ref)
RTC::ExecutionContextService_ptr	getECRef ()
CORBA::Boolean	isRunning ()
	ExecutionContext 実行状態確認関数
RTC::ReturnCode_t	start ()
	ExecutionContext の実行を開始
RTC::ReturnCode_t	stop ()
	ExecutionContext の実行を停止
RTC::ReturnCode_t	startThread ()
RTC::ReturnCode_t	stopThread ()
RTC::ReturnCode_t	rateChanged ()
	ExecutionContext の実行周期が変更された
RTC::ReturnCode_t	activateComponent (RTC::LightweightRTObject_ptr comp, RTObjectStateMachine *&rtobj)
	RTコンポーネントをアクティブ化する
RTC::ReturnCode_t	waitActivateComplete (RTObjectStateMachine *&rtobj, std::chrono::nanoseconds timeout=std::chrono::seconds(1), long int cycle=1000)
RTC::ReturnCode_t	deactivateComponent (RTC::LightweightRTObject_ptr comp, RTObjectStateMachine *&rtobj)
	RTコンポーネントを非アクティブ化する
RTC::ReturnCode_t	waitDeactivateComplete (RTObjectStateMachine *&rtobj, std::chrono::nanoseconds timeout=std::chrono::seconds(1), long int cycle=1000)
RTC::ReturnCode_t	resetComponent (RTC::LightweightRTObject_ptr comp, RTObjectStateMachine *&rtobj)
	RTコンポーネントをリセットする
RTC::ReturnCode_t	waitResetComplete (RTObjectStateMachine *&rtobj, std::chrono::nanoseconds timeout=std::chrono::seconds(1), long int cycle=1000)
RTC::LifeCycleState	getComponentState (RTC::LightweightRTObject_ptr comp)
	RTコンポーネントの状態を取得する
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 ()
	コンポーネントリストの更新

静的公開メンバ関数
static const char *	getStateString (RTC::LifeCycleState state)

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

限定公開変数類
RTC::Logger	rtclog {"ec_worker"}
	ロガーストリーム
RTC::ExecutionContextService_var	m_ref
bool	m_running {false}
	ExecutionContext の実行状態 true: running, false: stopped
std::vector< RTC_impl::RTObjectStateMachine * >	m_comps
	コンポーネントの参加者リスト
std::mutex	m_mutex
std::vector< RTC_impl::RTObjectStateMachine * >	m_addedComps
std::mutex	m_addedMutex
std::vector< RTC_impl::RTObjectStateMachine * >	m_removedComps
std::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, std::chrono::nanoseconds timeout = 1s, long int cycle = 1000);
- RTC::ReturnCode_t deactivateComponent(RTC::LightweightRTObject_ptr comp, * RTObjectStateMachine*& rtobj);
- RTC::ReturnCode_t waitDeactivateComplete(RTObjectStateMachine*& rtobj, std::chrono::nanoseconds timeout = 1s, long int cycle = 1000);
- RTC::ReturnCode_t resetComponent(RTC::LightweightRTObject_ptr com, RTObjectStateMachine*& rtobj);
- RTC::ReturnCode_t waitResetComplete(RTObjectStateMachine*& rtobj, std::chrono::nanoseconds timeout = 1s, 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

型定義メンバ詳解

◆ CompItr

using RTC_impl::ExecutionContextWorker::CompItr = std::vector<RTC_impl::RTObjectStateMachine*>::iterator

protected

構築子と解体子

◆ ExecutionContextWorker()

RTC_impl::ExecutionContextWorker::ExecutionContextWorker ( )

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

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

kind : PERIODIC
rate : 0.0

◆ ~ExecutionContextWorker()

virtual RTC_impl::ExecutionContextWorker::~ExecutionContextWorker ( )

virtual

デストラクタ

関数詳解

◆ activateComponent()

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 型のリターンコード

◆ addComponent()

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 型のリターンコード

◆ bindComponent()

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 型のリターンコード

◆ deactivateComponent()

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 型のリターンコード

◆ findComponent()

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

◆ getComponentState()

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

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

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

引数

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

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

◆ getECRef()

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

◆ getStateString()

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

inlinestatic

◆ invokeWorker()

void RTC_impl::ExecutionContextWorker::invokeWorker ( )

◆ invokeWorkerDo()

void RTC_impl::ExecutionContextWorker::invokeWorkerDo ( )

◆ invokeWorkerPostDo()

void RTC_impl::ExecutionContextWorker::invokeWorkerPostDo ( )

◆ invokeWorkerPreDo()

void RTC_impl::ExecutionContextWorker::invokeWorkerPreDo ( )

◆ isAllCurrentState()

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

◆ isAllNextState()

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

◆ isOneOfCurrentState()

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

◆ isOneOfNextState()

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

◆ isRunning()

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

ExecutionContext 実行状態確認関数

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

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

◆ rateChanged()

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

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

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

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

◆ removeComponent()

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

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

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

引数

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

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

◆ resetComponent()

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

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

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

引数

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

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

◆ setECRef()

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

◆ start()

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

ExecutionContext の実行を開始

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

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

◆ startThread()

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

◆ stop()

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

ExecutionContext の実行を停止

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

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

◆ stopThread()

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

◆ updateComponentList()

void RTC_impl::ExecutionContextWorker::updateComponentList ( )

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

◆ waitActivateComplete()

RTC::ReturnCode_t RTC_impl::ExecutionContextWorker::waitActivateComplete	(	RTObjectStateMachine *&	rtobj,
		std::chrono::nanoseconds	timeout = std::chrono::seconds(1),
		long int	cycle = 1000 )

◆ waitDeactivateComplete()

RTC::ReturnCode_t RTC_impl::ExecutionContextWorker::waitDeactivateComplete	(	RTObjectStateMachine *&	rtobj,
		std::chrono::nanoseconds	timeout = std::chrono::seconds(1),
		long int	cycle = 1000 )

◆ waitResetComplete()

RTC::ReturnCode_t RTC_impl::ExecutionContextWorker::waitResetComplete	(	RTObjectStateMachine *&	rtobj,
		std::chrono::nanoseconds	timeout = std::chrono::seconds(1),
		long int	cycle = 1000 )

メンバ詳解

◆ m_addedComps

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

protected

◆ m_addedMutex

std::mutex RTC_impl::ExecutionContextWorker::m_addedMutex

mutableprotected

◆ m_comps

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

protected

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

◆ m_mutex

std::mutex RTC_impl::ExecutionContextWorker::m_mutex

mutableprotected

◆ m_ref

RTC::ExecutionContextService_var RTC_impl::ExecutionContextWorker::m_ref

protected

◆ m_removedComps

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

protected

◆ m_removedMutex

std::mutex RTC_impl::ExecutionContextWorker::m_removedMutex

mutableprotected

◆ m_running

bool RTC_impl::ExecutionContextWorker::m_running {false}

protected

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

◆ rtclog

RTC::Logger RTC_impl::ExecutionContextWorker::rtclog {"ec_worker"}

protected

ロガーストリーム

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

ExecutionContextWorker.h

公開メンバ関数

静的公開メンバ関数

限定公開型

限定公開変数類

詳解

型定義メンバ詳解

◆ CompItr

構築子と解体子

◆ ExecutionContextWorker()

◆ ~ExecutionContextWorker()

関数詳解

◆ activateComponent()

◆ addComponent()

◆ bindComponent()

◆ deactivateComponent()

◆ findComponent()

◆ getComponentState()

◆ getECRef()

◆ getStateString()

◆ invokeWorker()

◆ invokeWorkerDo()

◆ invokeWorkerPostDo()

◆ invokeWorkerPreDo()

◆ isAllCurrentState()

◆ isAllNextState()

◆ isOneOfCurrentState()

◆ isOneOfNextState()

◆ isRunning()

◆ rateChanged()

◆ removeComponent()

◆ resetComponent()

◆ setECRef()

◆ start()

◆ startThread()

◆ stop()

◆ stopThread()

◆ updateComponentList()

◆ waitActivateComplete()

◆ waitDeactivateComplete()

◆ waitResetComplete()

メンバ詳解

◆ m_addedComps

◆ m_addedMutex

◆ m_comps

◆ m_mutex

◆ m_ref

◆ m_removedComps

◆ m_removedMutex

◆ m_running

◆ rtclog