ExecutionContext用基底クラス [詳解]

#include <ExecutionContextBase.h>

RTC::ExecutionContextBase の継承関係図

[凡例]

RTC::ExecutionContextBase 連携図

[凡例]

公開メンバ関数
	ExecutionContextBase (const char *name)
	仮想デストラクタ [詳解]

virtual	~ExecutionContextBase (void)
	仮想デストラクタ [詳解]

virtual void	init (coil::Properties &props)
	ExecutionContextの初期化を行う [詳解]

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

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

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

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

double	getRate (void) const
	ExecutionContext の実行周期(Hz)を取得する [詳解]

coil::TimeValue	getPeriod (void) const

RTC::ReturnCode_t	setRate (double rate)
	ExecutionContext の実行周期(Hz)を設定する [詳解]

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

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

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

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

RTC::ReturnCode_t	resetComponent (RTC::LightweightRTObject_ptr comp)
	RTコンポーネントをリセットする [詳解]

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

const char *	getStateString (RTC::LifeCycleState state)

RTC::ExecutionKind	getKind (void) const
	ExecutionKind を取得する [詳解]

RTC::ExecutionContextProfile *	getProfile (void)
	Profileを取得する [詳解]

void	setObjRef (RTC::ExecutionContextService_ptr ec_ptr)
	CORBA オブジェクト参照の取得 [詳解]

RTC::ExecutionContextService_ptr	getObjRef (void) const
	CORBA オブジェクト参照の取得 [詳解]

const char *	getKindString (RTC::ExecutionKind kind) const
	ExecutionKind を文字列化する [詳解]

RTC::ReturnCode_t	setKind (RTC::ExecutionKind kind)
	ExecutionKind を設定する [詳解]

RTC::ReturnCode_t	setOwner (RTC::LightweightRTObject_ptr comp)
	Ownerコンポーネントをセットする。 [詳解]

const RTC::RTObject_ptr	getOwner () const
	Ownerコンポーネントの参照を取得する [詳解]

const RTC::RTCList &	getComponentList () const
	RTコンポーネントの参加者リストを取得する [詳解]

void	setProperties (coil::Properties &props)
	Propertiesをセットする [詳解]

const coil::Properties	getProperties () const
	Propertiesを取得する [詳解]

const RTC::ExecutionContextProfile &	getProfile (void) const
	Profileを取得する [詳解]

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 ()

限定公開メンバ関数
virtual bool	onIsRunning (bool running)

virtual RTC::ReturnCode_t	onStarting ()

virtual RTC::ReturnCode_t	onStarted ()

virtual RTC::ReturnCode_t	onStopping ()

virtual RTC::ReturnCode_t	onStopped ()

virtual double	onGetRate (double rate) const

virtual double	onSettingRate (double rate)

virtual RTC::ReturnCode_t	onSetRate (double rate)

virtual RTC::ReturnCode_t	onAddingComponent (RTC::LightweightRTObject_ptr rtobj)

virtual RTC::ReturnCode_t	onAddedComponent (RTC::LightweightRTObject_ptr rtobj)

virtual RTC::ReturnCode_t	onRemovingComponent (RTC::LightweightRTObject_ptr rtobj)

virtual RTC::ReturnCode_t	onRemovedComponent (RTC::LightweightRTObject_ptr rtobj)

virtual RTC::ReturnCode_t	onActivating (RTC::LightweightRTObject_ptr comp)

virtual RTC::ReturnCode_t	onWaitingActivated (RTC_impl::RTObjectStateMachine *comp, long int count)

virtual RTC::ReturnCode_t	onActivated (RTC_impl::RTObjectStateMachine *comp, long int count)

virtual RTC::ReturnCode_t	onDeactivating (RTC::LightweightRTObject_ptr comp)

virtual RTC::ReturnCode_t	onWaitingDeactivated (RTC_impl::RTObjectStateMachine *comp, long int count)

virtual RTC::ReturnCode_t	onDeactivated (RTC_impl::RTObjectStateMachine *comp, long int count)

virtual RTC::ReturnCode_t	onResetting (RTC::LightweightRTObject_ptr comp)

virtual RTC::ReturnCode_t	onWaitingReset (RTC_impl::RTObjectStateMachine *comp, long int count)

virtual RTC::ReturnCode_t	onReset (RTC_impl::RTObjectStateMachine *comp, long int count)

virtual RTC::LifeCycleState	onGetComponentState (RTC::LifeCycleState state)

virtual RTC::ExecutionKind	onGetKind (RTC::ExecutionKind kind) const

virtual RTC::ExecutionContextProfile *	onGetProfile (RTC::ExecutionContextProfile *&profile)

限定公開変数類
RTC::Logger	rtclog

RTC_impl::ExecutionContextWorker	m_worker

RTC_impl::ExecutionContextProfile	m_profile

coil::TimeValue	m_activationTimeout

coil::TimeValue	m_deactivationTimeout

coil::TimeValue	m_resetTimeout

bool	m_syncActivation

bool	m_syncDeactivation

bool	m_syncReset

詳解

ExecutionContext用基底クラス

ECの実装クラスでは、この基底クラスを継承し、かつECのCORBAオペレーションを実装しなければならない。さらに、実際にロジックを駆動するため、幾つかの約束に則りExecutionContextBaseの関数を呼び出す必要がある。ECのCORBAオペレーションは以下のものがあり、それぞれ ExecutionContextBaseのメンバ関数に対応している。

is_running(): ExecutionContextBase::isRunning()
start(): ExecutionContextBase::start()
stop(): ExecutionContextBase::stop()
get_rate(): ExecutionContextBase::gatRate()
set_rate(): ExecutioinContextBase::setRate()
add_component(): ExecutionContextBase::addComponent()
remove_component(): ExecutionContextBase::removeComponent()
activate_component(): ExecutionContextBase::activateComponent()
deactivate_component(): ExecutionContextBase::deactivateComponent()
reset_component(): ExecutionContextBase::resetComponent()
get_component_state(): ExecutionContextBase::getComponentState()
get_kind(): ExecutionContextBase::getKind()
get_profile(): ExecutionContextBase::getProfile()

実行状態に関係する関数と実装方法

is_running(): ExecutionContextBase::isRunning()
start(): ExecutionContextBase::start()
stop(): ExecutionContextBase::stop()

実行状態に関係する関数は、is_running(), start(), stop() の3つがある。ExecutionContextBaseでは単純に running/stopped のフラグを持っており、start/stopでフラグのON/OFF切り替え、is_running()で状態読み出しを行っている。通常、ECの実装クラスでは、protected な仮想メンバ関数 onStarting(), onStarted(), onStopping(), onStopped() 関数を実装したうえで、CORBAオペレーションを以下のように実装する必要がある。

is_running() のCORBAオペレーションでは、単純に ExecutionContextBase の isRunning() を呼び出すだけである。この関数に関連する protected 仮想関数はonIsRunning() が用意されているが、通常特に実装する必要はない。あえて、現在の running/stopped 状態を書き換えたい場合にこの関数を利用することができるが推奨はされない。

public:
 CORBA::Boolean is_runing()
 {
   return ExecutionContextBase::isRunning();
 }
protected:
 CORBA::Boolean onIsRunning(CORBA::Boolean running)
 {
   return running;
 }

start(), stop() CORBAオペレーションでは、通常 ExecutionContextBase の start(), stop() 関数を呼び出すよう実装する。この関数に関連する protected 仮想関数は、start() および stop() についてそれぞれ2つづつの onStarting(), onStarted(), および onStopping(), onStopped() 関数がある。ECの実装クラスにおいては、それぞれ以下のように実装する。

 RTC::ReturnCode_t start()
 {
   return ExecutionContextBase::start();
 }
 RTC::ReturnCode_t stop()
 {
   return ExecutionContextBase::stop();
 }
protected:
 RTC::ReturnCode_t onStarting()
 {
   RTC::ReturnCode_t ret = // スレッドを開始する処理など
   return ret;
 }
 RTC::ReturnCode_t onStarted()
 {
   RTC::ReturnCode_t ret = // スレッドを開始する処理など
   return ret;
 }
 RTC::ReturnCode_t onStopping()
 {
   // スレッドを停止する処理など
   return retcode;
 }
 RTC::ReturnCode_t onStopped()
 {
   // スレッドを停止する処理など
   return retcode;
 }

実行周期に関する関数と実装方法

get_rate(): ExecutionContextBase::gatRate()
set_rate(): ExecutioinContextBase::setRate()

実行周期に関する関数は set_rate(), get_rate() の2種類がある。実装する実行コンテキストがもし set_rate() により指定される周期を利用する場合、テンプレート関数 onSetRate() をオーバーライドし実装する。 onSetRate() は引数に double 型の周期を取り、この値は正当な値であることが保証されている。onSetRate() がRTC::RTC_OK 以外の値を返した場合、ECのProfileの周期は設定される以前の値を保持することが保証される。

set_rate() 同様 get_rate() 呼び出し時にonGetRate() が呼び出されるが、これは通常オーバーライド剃る必要はない。ただし、get_rate() が返す値を変更したい場合、onGetRate() をオーバーライドすることでその値を書き換えることができる。ただし、これは推奨されない。

public:
 RTC::ReturnCode_t set_rate(double rate)
 {
   return setRate(rate);
 }
 double get_rate(void) const
 {
   return getRate();
 }
protected:
 virtual RTC::ReturnCode_t onSetRate(double rate)
 {
   RTC::ReturnCode_t ret = // 周期を設定する何らかの処理
   if (ret != RTC::RTC_OK)
     {
       RTC_ERROR(("Error message"));
     }
   return ret;
 }
 virtual double onGetRate(rate)
 {
   // get_rate() が返す値を加工したい場合
   // 通常はこの関数を実装する必要はない。
   return rate;
 }

コンポーネントの追加と削除に関する関数

add_component(): ExecutionContextBase::addComponent()
remove_component(): ExecutionContextBase::removeComponent()

コンポーネントの追加と削除に関する関数は、add_component(), remove_component() の二種類がある。実行コンテキストの実装クラスにおいては、ExecutionContextBase のそれぞれ addComponent(), removeComponent() を呼び出す形で実装を行う。これらの関数に関連する protected 仮想関数は onAddingComponent(), onAddedComponent(), onRemovingComponent(), onRemovedComponent() の4種類ある。ただし、これらの仮想関数は通常オーバーライドする必要はなく、使用は推奨されない。

public:
 RTC::ReturnCode_t add_component(RTC::LightweightRTObject_ptr comp)
 {
   return ExecutionContextBase::addComponent(comp);
 }
 RTC::ReturnCode_t remove_component(RTC::LightweightRTObject_ptr comp)
 {
   return ExecutionContextBase::removeComponent(comp);
 }
protected:
 virtual RTC::ReturnCode_t
 onAddingComponent(RTC::LightweightRTObject rtobj)
 {
    // コンポーネント追加時に実行したい処理を記述
    // RTC::RTC_OK 以外を返した場合、コンポーネントの追加は行われない。
    return RTC::RTC_OK;
 }
 virtual RTC::ReturnCode_t
 onAddedComponent(RTC::LightweightRTObject rtobj)
 {
    // コンポーネント追加時に実行したい処理を記述
    // RTC::RTC_OK 以外を返した場合、removeComponent() が呼び出され、
    // 追加されたコンポーネントが削除される。
    return RTC::RTC_OK;
 }
 virtual RTC::ReturnCode_t
 onRemovingComponent(RTC::LightweightRTObject rtobj)
 {
    // コンポーネント削除時に実行したい処理を記述
    // RTC::RTC_OK 以外を返した場合、コンポーネントの削除は行われない。
    return RTC::RTC_OK;
 }
 virtual RTC::ReturnCode_t
 onRemovedComponent(RTC::LightweightRTObject rtobj)
 {
    // コンポーネント追加時に実行したい処理を記述
    // RTC::RTC_OK 以外を返した場合、addComponent() が呼び出され、
    // 削除されたコンポーネントが再び追加される。
    return RTC::RTC_OK;
 }

コンポーネントのアクティブ化等に関する関数

activate_component(): ExecutionContextBase::activateComponent()
deactivate_component(): ExecutionContextBase::deactivateComponent()
reset_component(): ExecutionContextBase::resetComponent()

コンポーネントのアクティブ化等に関する関数は、 activate_component(), deactivate_component(), reset_component() の三種類がある。実行コンテキストの実装クラスにおいては、 ExecutionContextBase のそれぞれ activateComponent(), deactivateComponent(), resetComponent() を呼び出す形で実装を行う。これらの関数に関連する protected 仮想関数は onActivatingComponent(), onAtivatingComponent(), onActivatedComponent(), onDeactivatingComponent(), onDeactivatedComponent(), onResettingComponent(), onResetComponent() の6種類ある。ただし、これらの仮想関数は通常オーバーライドする必要はなく、使用は推奨されない。

public:
 RTC::ReturnCode_t add_component(RTC::LightweightRTObject_ptr comp)
 {
   return ExecutionContextBase::addComponent(comp);
 }
 RTC::ReturnCode_t remove_component(RTC::LightweightRTObject_ptr comp)
 {
   return ExecutionContextBase::removeComponent(comp);
 }
protected:
 virtual RTC::ReturnCode_t
 onAddingComponent(RTC::LightweightRTObject rtobj)
 {
   // コンポーネント追加時に実行したい処理を記述
   // RTC::RTC_OK 以外を返した場合、コンポーネントの追加は行われない。
   return RTC::RTC_OK;
 }
 virtual RTC::ReturnCode_t
 onAddedComponent(RTC::LightweightRTObject rtobj)
 {
   // コンポーネント追加時に実行したい処理を記述
   // RTC::RTC_OK 以外を返した場合、removeComponent() が呼び出され、
   // 追加されたコンポーネントが削除される。
   return RTC::RTC_OK;
 }
 virtual RTC::ReturnCode_t
 onRemovingComponent(RTC::LightweightRTObject rtobj)
 {
   // コンポーネント削除時に実行したい処理を記述
   // RTC::RTC_OK 以外を返した場合、コンポーネントの削除は行われない。
   return RTC::RTC_OK;
 }
 virtual RTC::ReturnCode_t
 onRemovedComponent(RTC::LightweightRTObject rtobj)
 {
   // コンポーネント追加時に実行したい処理を記述
   // RTC::RTC_OK 以外を返した場合、addComponent() が呼び出され、
   // 削除されたコンポーネントが再び追加される。
   return RTC::RTC_OK;
 }

実行コンテキストの情報取得に関する関数

get_component_state(): ExecutionContextBase::getComponentState()
get_kind(): ExecutionContextBase::getKind()
get_profile(): ExecutionContextBase::getProfile()

実行コンテキストの情報取得に関する関数は、get_component_state(), get_kind(), get_profile() の3種類がある。実行コンテキストの実装クラスにおいては、ExecutionContextBase のそれぞれ getComponentState(), getKind(), getProfile() を呼び出す形で実装を行う。これらの関数に関連する protected 仮想関数は onGetComponentState(), onGetKind(), onGetProfile() の3種類ある。これらの仮想関数は通常オーバーライドする必要はなく、使用は推奨されない。ただし、返す情報を変更したい場合は、これらの関数を適切に実装することで、呼び出し側に返す値を上書きすることができる。

public:
 LifeCycleState get_component_state(RTC::LightweightRTObject_ptr comp)
 {
   return getComponentState(comp);
 }
 ExecutionKind PeriodicExecutionContext::get_kind()
 {
   return getKind();
 }
 ExecutionContextProfile* get_profile()
 {
   return getProfile();
 }

protected:
 virtual LifeCycleState onGetComponentState(LifeCycleState state)
 { // 返すstateを書き換えたい場合はこの関数を実装する
   return state;
 }
 virtual ExecutionKind onGetKind(ExecutionKind kind)
 { // 返すkindを書き換えたい場合はこの関数を実装する
   return kind;
 }
 virtual ExecutionContextProfile*
 onGetProfile(ExecutionContextProfile*& profile)
 { // 返すprofileを書き換えたい場合はこの関数を実装する
   return profile;
 }

[ExecutionContextBase] <> | +–(1 1) [ExecutionContextWorker ] : EC の worker | <> | +–(1 0..) [RTObjectStateMachine] : StateMachine | +–(1 1) [ExecutionContextProfile] : EC Profileの管理

から: 0.4.0

構築子と解体子

RTC::ExecutionContextBase::ExecutionContextBase ( const char * name )

仮想デストラクタ

virtual RTC::ExecutionContextBase::~ExecutionContextBase ( void )

virtual

仮想デストラクタ

関数詳解

RTC::ReturnCode_t RTC::ExecutionContextBase::activateComponent ( RTC::LightweightRTObject_ptr comp )

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

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

引数

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

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

RTC::ReturnCode_t RTC::ExecutionContextBase::addComponent ( RTC::LightweightRTObject_ptr comp )

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

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

引数

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

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

virtual RTC::ReturnCode_t RTC::ExecutionContextBase::bindComponent ( RTC::RTObject_impl * rtc )

virtual

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

RTC::ReturnCode_t RTC::ExecutionContextBase::deactivateComponent ( RTC::LightweightRTObject_ptr comp )

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

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

|

引数

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

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

const RTC::RTCList& RTC::ExecutionContextBase::getComponentList ( ) const

RTコンポーネントの参加者リストを取得する

現在登録されている参加者RTCのリストを取得する。

戻り値: 参加者RTCのリスト

RTC::LifeCycleState RTC::ExecutionContextBase::getComponentState ( RTC::LightweightRTObject_ptr comp )

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

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

引数

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

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

RTC::ExecutionKind RTC::ExecutionContextBase::getKind ( void ) const

ExecutionKind を取得する

本 ExecutionContext の ExecutionKind を取得する

戻り値: ExecutionKind

const char* RTC::ExecutionContextBase::getKindString ( RTC::ExecutionKind kind ) const

ExecutionKind を文字列化する

RTC::ExecutionKind で定義されている PERIODIC, EVENT_DRIVEN, OTHER を文字列化する。

引数

kind	ExecutionKind

戻り値: 文字列化されたExecutionKind

RTC::ExecutionContextService_ptr RTC::ExecutionContextBase::getObjRef ( void ) const

CORBA オブジェクト参照の取得

本オブジェクトの ExecutioncontextService としての CORBA オブジェクト参照を取得する。

戻り値: CORBA オブジェクト参照

const RTC::RTObject_ptr RTC::ExecutionContextBase::getOwner ( ) const

Ownerコンポーネントの参照を取得する

このECのOwnerであるRTCの参照を取得する。

戻り値: OwnerRTコンポーネントの参照

coil::TimeValue RTC::ExecutionContextBase::getPeriod ( void ) const

RTC::ExecutionContextProfile* RTC::ExecutionContextBase::getProfile ( void )

Profileを取得する

RTC::ExecutionContextProfile を取得する。取得した ExecutionContextProfile の所有権は呼び出し側にある。取得されたオブジェクトが不要になった場合、呼び出し側が開放する責任を負う。

戻り値: RTC::ExecutionContextProfile

const RTC::ExecutionContextProfile& RTC::ExecutionContextBase::getProfile ( void ) const

Profileを取得する

RTC::ExecutionContextProfile を取得する。

戻り値: RTC::ExecutionContextProfile

const coil::Properties RTC::ExecutionContextBase::getProperties ( ) const

Propertiesを取得する

ExecutionContextProfile::properties を取得する。

戻り値: coil::Propertiesに変換された ExecutionContextProfile::properties

double RTC::ExecutionContextBase::getRate ( void ) const

ExecutionContext の実行周期(Hz)を取得する

Active 状態にてRTコンポーネントが実行される周期(単位:Hz)を取得する。

戻り値: 処理周期(単位:Hz)

const char* RTC::ExecutionContextBase::getStateString ( RTC::LifeCycleState state )

virtual void RTC::ExecutionContextBase::init ( coil::Properties & props )

virtual

ExecutionContextの初期化を行う

ExecutionContextの初期化処理

RTC_exp::PeriodicExecutionContextで再実装されています。

void RTC::ExecutionContextBase::invokeWorker ( )

inline

void RTC::ExecutionContextBase::invokeWorkerDo ( )

inline

void RTC::ExecutionContextBase::invokeWorkerPostDo ( )

inline

void RTC::ExecutionContextBase::invokeWorkerPreDo ( )

inline

bool RTC::ExecutionContextBase::isAllCurrentState ( RTC::LifeCycleState state )

inline

bool RTC::ExecutionContextBase::isAllNextState ( RTC::LifeCycleState state )

inline

bool RTC::ExecutionContextBase::isOneOfCurrentState ( RTC::LifeCycleState state )

inline

bool RTC::ExecutionContextBase::isOneOfNextState ( RTC::LifeCycleState state )

inline

CORBA::Boolean RTC::ExecutionContextBase::isRunning ( )

ExecutionContext 実行状態確認関数

この操作は ExecutionContext が Runnning 状態の場合に true を返す。返り値は、start() 関数が呼ばれたあとはRunning状態となり true を、stop() 関数が呼ばれたあとはStopped状態となりfalseを返す。

戻り値: 動作状態 (Running状態:true、Stopped状態: false)

virtual RTC::ReturnCode_t RTC::ExecutionContextBase::onActivated	(	RTC_impl::RTObjectStateMachine *	comp,
		long int	count
	)

inlineprotectedvirtual

RTC_exp::PeriodicExecutionContextで再実装されています。

virtual RTC::ReturnCode_t RTC::ExecutionContextBase::onActivating ( RTC::LightweightRTObject_ptr comp )

inlineprotectedvirtual

virtual RTC::ReturnCode_t RTC::ExecutionContextBase::onAddedComponent ( RTC::LightweightRTObject_ptr rtobj )

inlineprotectedvirtual

RTC_exp::PeriodicExecutionContext, RTC::ExtTrigExecutionContext, RTC::OpenHRPExecutionContextで再実装されています。

virtual RTC::ReturnCode_t RTC::ExecutionContextBase::onAddingComponent ( RTC::LightweightRTObject_ptr rtobj )

inlineprotectedvirtual

virtual RTC::ReturnCode_t RTC::ExecutionContextBase::onDeactivated	(	RTC_impl::RTObjectStateMachine *	comp,
		long int	count
	)

inlineprotectedvirtual

RTC_exp::PeriodicExecutionContextで再実装されています。

virtual RTC::ReturnCode_t RTC::ExecutionContextBase::onDeactivating ( RTC::LightweightRTObject_ptr comp )

inlineprotectedvirtual

virtual RTC::LifeCycleState RTC::ExecutionContextBase::onGetComponentState ( RTC::LifeCycleState state )

inlineprotectedvirtual

virtual RTC::ExecutionKind RTC::ExecutionContextBase::onGetKind ( RTC::ExecutionKind kind ) const

inlineprotectedvirtual

virtual RTC::ExecutionContextProfile* RTC::ExecutionContextBase::onGetProfile ( RTC::ExecutionContextProfile *& profile )

inlineprotectedvirtual

virtual double RTC::ExecutionContextBase::onGetRate ( double rate ) const

inlineprotectedvirtual

virtual bool RTC::ExecutionContextBase::onIsRunning ( bool running )

inlineprotectedvirtual

virtual RTC::ReturnCode_t RTC::ExecutionContextBase::onRemovedComponent ( RTC::LightweightRTObject_ptr rtobj )

inlineprotectedvirtual

RTC_exp::PeriodicExecutionContext, RTC::ExtTrigExecutionContext, RTC::OpenHRPExecutionContextで再実装されています。

virtual RTC::ReturnCode_t RTC::ExecutionContextBase::onRemovingComponent ( RTC::LightweightRTObject_ptr rtobj )

inlineprotectedvirtual

virtual RTC::ReturnCode_t RTC::ExecutionContextBase::onReset	(	RTC_impl::RTObjectStateMachine *	comp,
		long int	count
	)

inlineprotectedvirtual

RTC_exp::PeriodicExecutionContextで再実装されています。

virtual RTC::ReturnCode_t RTC::ExecutionContextBase::onResetting ( RTC::LightweightRTObject_ptr comp )

inlineprotectedvirtual

virtual RTC::ReturnCode_t RTC::ExecutionContextBase::onSetRate ( double rate )

inlineprotectedvirtual

virtual double RTC::ExecutionContextBase::onSettingRate ( double rate )

inlineprotectedvirtual

virtual RTC::ReturnCode_t RTC::ExecutionContextBase::onStarted ( )

inlineprotectedvirtual

RTC_exp::PeriodicExecutionContext, RTC::ExtTrigExecutionContextで再実装されています。

virtual RTC::ReturnCode_t RTC::ExecutionContextBase::onStarting ( )

inlineprotectedvirtual

virtual RTC::ReturnCode_t RTC::ExecutionContextBase::onStopped ( )

inlineprotectedvirtual

virtual RTC::ReturnCode_t RTC::ExecutionContextBase::onStopping ( )

inlineprotectedvirtual

RTC_exp::PeriodicExecutionContextで再実装されています。

virtual RTC::ReturnCode_t RTC::ExecutionContextBase::onWaitingActivated	(	RTC_impl::RTObjectStateMachine *	comp,
		long int	count
	)

inlineprotectedvirtual

RTC_exp::PeriodicExecutionContext, RTC::ExtTrigExecutionContextで再実装されています。

virtual RTC::ReturnCode_t RTC::ExecutionContextBase::onWaitingDeactivated	(	RTC_impl::RTObjectStateMachine *	comp,
		long int	count
	)

inlineprotectedvirtual

RTC_exp::PeriodicExecutionContext, RTC::ExtTrigExecutionContextで再実装されています。

virtual RTC::ReturnCode_t RTC::ExecutionContextBase::onWaitingReset	(	RTC_impl::RTObjectStateMachine *	comp,
		long int	count
	)

inlineprotectedvirtual

RTC_exp::PeriodicExecutionContext, RTC::ExtTrigExecutionContextで再実装されています。

RTC::ReturnCode_t RTC::ExecutionContextBase::removeComponent ( RTC::LightweightRTObject_ptr comp )

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

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

引数

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

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

RTC::ReturnCode_t RTC::ExecutionContextBase::resetComponent ( RTC::LightweightRTObject_ptr comp )

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

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

引数

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

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

RTC::ReturnCode_t RTC::ExecutionContextBase::setKind ( RTC::ExecutionKind kind )

ExecutionKind を設定する

この ExecutionContext の ExecutionKind を設定する

引数

kind	ExecutionKind

void RTC::ExecutionContextBase::setObjRef ( RTC::ExecutionContextService_ptr ec_ptr )

CORBA オブジェクト参照の取得

本オブジェクトの ExecutioncontextService としての CORBA オブジェクト参照を取得する。

戻り値: CORBA オブジェクト参照

RTC::ReturnCode_t RTC::ExecutionContextBase::setOwner ( RTC::LightweightRTObject_ptr comp )

Ownerコンポーネントをセットする。

このECのOwnerとなるRTCをセットする。

引数

comp	OwnerとなるRTコンポーネント

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

void RTC::ExecutionContextBase::setProperties ( coil::Properties & props )

Propertiesをセットする

ExecutionContextProfile::properties をセットする。

引数

props ExecutionContextProfile::properties にセットするプロパティー

RTC::ReturnCode_t RTC::ExecutionContextBase::setRate ( double rate )

ExecutionContext の実行周期(Hz)を設定する

Active 状態にてRTコンポーネントが実行される周期(単位:Hz)を設定する。実行周期の変更は、DataFlowComponentAction の on_rate_changed によって各RTコンポーネントに伝達される。

引数

rate	処理周期(単位:Hz)

戻り値: ReturnCode_t 型のリターンコード RTC_OK: 正常終了 BAD_PARAMETER: 設定値が負の値

RTC::ReturnCode_t RTC::ExecutionContextBase::start ( void )

ExecutionContext の実行を開始

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

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

virtual RTC::ReturnCode_t RTC::ExecutionContextBase::stop ( void )

virtual

ExecutionContext の実行を停止

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

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

RTC_exp::PeriodicExecutionContext, RTC::ExtTrigExecutionContext, RTC::OpenHRPExecutionContextで再実装されています。

メンバ詳解

coil::TimeValue RTC::ExecutionContextBase::m_activationTimeout

protected

coil::TimeValue RTC::ExecutionContextBase::m_deactivationTimeout

protected

RTC_impl::ExecutionContextProfile RTC::ExecutionContextBase::m_profile

protected

coil::TimeValue RTC::ExecutionContextBase::m_resetTimeout

protected

bool RTC::ExecutionContextBase::m_syncActivation

protected

bool RTC::ExecutionContextBase::m_syncDeactivation

protected

bool RTC::ExecutionContextBase::m_syncReset

protected

RTC_impl::ExecutionContextWorker RTC::ExecutionContextBase::m_worker

protected

RTC::Logger RTC::ExecutionContextBase::rtclog

mutableprotected

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

ExecutionContextBase.h

公開メンバ関数

限定公開メンバ関数

限定公開変数類

詳解

構築子と解体子

関数詳解

メンバ詳解