ExecutionContextProfile クラス [詳解]

#include <ExecutionContextProfile.h>

公開メンバ関数
	ExecutionContextProfile (RTC::ExecutionKind kind=RTC::PERIODIC)
	デフォルトコンストラクタ [詳解]

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

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

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

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

RTC::ReturnCode_t	setPeriod (double period)

RTC::ReturnCode_t	setPeriod (coil::TimeValue period)

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

coil::TimeValue	getPeriod (void) const

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

const char *	getKindString () const

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

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

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

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

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

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

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

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

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

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

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

void	lock () const
	ExecutionContextProfileをロックする [詳解]

void	unlock () const
	ExecutionContextProfileをアンロックする [詳解]

詳解

ExecutionContextProfile クラス

Periodic Sampled Data Processing(周期実行用)ExecutionContextクラス。

から: 0.4.0

構築子と解体子

RTC_impl::ExecutionContextProfile::ExecutionContextProfile ( RTC::ExecutionKind kind = RTC::PERIODIC )

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

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

kind : PERIODIC
rate : 0.0

virtual RTC_impl::ExecutionContextProfile::~ExecutionContextProfile ( void )

virtual

デストラクタ

関数詳解

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

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

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

引数

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

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

参照元 getKindString().

const RTC::RTCList& RTC_impl::ExecutionContextProfile::getComponentList ( ) const

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

現在登録されている参加者RTCのリストを取得する。この関数はコンポーネントリストのメンバ変数への参照を返すので、リスト使用前に ExecutionContextProfile::lock() でロックし、リスト使用後は ExecutionContextProfile::unlock() でロックを開放しなければならない。

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

参照元 getKindString().

RTC::ExecutionKind RTC_impl::ExecutionContextProfile::getKind ( void ) const

ExecutionKind を取得する

本 ExecutionContext の ExecutionKind を取得する

戻り値: ExecutionKind

参照元 getKindString().

const char* RTC_impl::ExecutionContextProfile::getKindString ( RTC::ExecutionKind kind ) const

ExecutionKind を文字列化する

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

引数

kind	ExecutionKind

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

const char* RTC_impl::ExecutionContextProfile::getKindString ( ) const

inline

参照先 addComponent(), getComponentList(), getKind(), getOwner(), getProfile(), getProperties(), lock(), removeComponent(), setKind(), setOwner(), setProperties(), unlock().

RTC::ExecutionContextService_ptr RTC_impl::ExecutionContextProfile::getObjRef ( void ) const

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

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

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

const RTC::RTObject_ptr RTC_impl::ExecutionContextProfile::getOwner ( ) const

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

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

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

参照元 getKindString().

coil::TimeValue RTC_impl::ExecutionContextProfile::getPeriod ( void ) const

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

Profileを取得する

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

戻り値: RTC::ExecutionContextProfile

参照元 getKindString().

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

Profileを取得する

RTC::ExecutionContextProfile を取得する。

戻り値: RTC::ExecutionContextProfile

const coil::Properties RTC_impl::ExecutionContextProfile::getProperties ( ) const

Propertiesを取得する

ExecutionContextProfile::properties を取得する。

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

参照元 getKindString().

double RTC_impl::ExecutionContextProfile::getRate ( void ) const

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

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

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

void RTC_impl::ExecutionContextProfile::lock ( ) const

ExecutionContextProfileをロックする

このオブジェクトが管理する RTC::ExecutionContextProfile をロックする。ロックが不要になった際にはunlock()でロックを解除しなければならない。

参照元 getKindString().

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

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

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

引数

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

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

参照元 getKindString().

RTC::ReturnCode_t RTC_impl::ExecutionContextProfile::setKind ( RTC::ExecutionKind kind )

ExecutionKind を設定する

この ExecutionContext の ExecutionKind を設定する

引数

kind	ExecutionKind

参照元 getKindString().

void RTC_impl::ExecutionContextProfile::setObjRef ( RTC::ExecutionContextService_ptr ec_ptr )

CORBA オブジェクト参照のセット

ExecutioncontextService の CORBA オブジェクト参照をセットする。セットされると、それまでセットされていたオブジェクト参照は releaseされる。セットするオブジェクト参照は有効な参照でなければならない。

引数

ec_ptr ExecutionContextServiceのCORBAオブジェクト参照

RTC::ReturnCode_t RTC_impl::ExecutionContextProfile::setOwner ( RTC::LightweightRTObject_ptr comp )

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

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

引数

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

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

参照元 getKindString().

RTC::ReturnCode_t RTC_impl::ExecutionContextProfile::setPeriod ( double period )

RTC::ReturnCode_t RTC_impl::ExecutionContextProfile::setPeriod ( coil::TimeValue period )

void RTC_impl::ExecutionContextProfile::setProperties ( coil::Properties & props )

Propertiesをセットする

ExecutionContextProfile::properties をセットする。

引数

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

参照元 getKindString().

RTC::ReturnCode_t RTC_impl::ExecutionContextProfile::setRate ( double rate )

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

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

引数

rate	処理周期(単位:Hz)

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

void RTC_impl::ExecutionContextProfile::unlock ( ) const

ExecutionContextProfileをアンロックする

このオブジェクトが管理する RTC::ExecutionContextProfile をアンロックする。

参照元 getKindString().

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

ExecutionContextProfile.h

公開メンバ関数

詳解

構築子と解体子

関数詳解