オブジェクトリファレンスを保持するプレースホルダ基底クラス [詳解]

#include <CorbaConsumer.h>

RTC::CorbaConsumerBase の継承関係図

[凡例]

公開メンバ関数
	CorbaConsumerBase ()=default
	コンストラクタ

	CorbaConsumerBase (const CorbaConsumerBase &x)
	コピーコンストラクタ

CorbaConsumerBase &	operator= (const CorbaConsumerBase &x)
	代入演算子

void	swap (CorbaConsumerBase &x)
	swap関数

virtual	~CorbaConsumerBase ()
	仮想デストラクタ

virtual bool	setObject (CORBA::Object_ptr obj)
	CORBAオブジェクトをセットする

virtual CORBA::Object_ptr	getObject ()
	CORBAオブジェクトを取得する

virtual void	releaseObject ()
	CORBAオブジェクトの設定をクリアする

限定公開変数類
CORBA::Object_var	m_objref
	設定された CORBA オブジェクト

詳解

オブジェクトリファレンスを保持するプレースホルダ基底クラス

通信手段として CORBA を選択した場合のコンシューマ実装のための基底クラス

から: 0.4.0

構築子と解体子

◆ CorbaConsumerBase() [1/2]

RTC::CorbaConsumerBase::CorbaConsumerBase ( )

default

コンストラクタ

◆ CorbaConsumerBase() [2/2]

RTC::CorbaConsumerBase::CorbaConsumerBase ( const CorbaConsumerBase & x )

inline

コピーコンストラクタ

引数

x	コピー元のCorbaConsumerBaseオブジェクト

◆ ~CorbaConsumerBase()

virtual RTC::CorbaConsumerBase::~CorbaConsumerBase ( )

inlinevirtual

仮想デストラクタ

参照先 releaseObject().

関数詳解

◆ getObject()

virtual CORBA::Object_ptr RTC::CorbaConsumerBase::getObject ( )

inlinevirtual

CORBAオブジェクトを取得する

ConsumerBase オブジェクト内に CORBA::Object_var 型として保持されているオブジェクトリファレンスを取得する。呼び出し側はvar型変数で受けるか、使用後CORBA::release()を呼び出して参照カウントをデクリメントすること。

戻り値: obj CORBA オブジェクトのリファレンス

参照先 m_objref.

◆ operator=()

CorbaConsumerBase & RTC::CorbaConsumerBase::operator= ( const CorbaConsumerBase & x )

inline

代入演算子

引数

x 代入元

戻り値: 代入結果

参照先 swap().

◆ releaseObject()

virtual void RTC::CorbaConsumerBase::releaseObject ( )

inlinevirtual

CORBAオブジェクトの設定をクリアする

設定されている CORBA オブジェクトをクリアする。 CORBAオブジェクトそのものに対しては何も操作しない。

RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >, RTC::CorbaConsumer< ::OpenRTM::InPortCdr >, RTC::CorbaConsumer< ::OpenRTM::InPortCdrUDP >, RTC::CorbaConsumer< ::OpenRTM::OutPortCdr >, RTC::CorbaConsumer< ::OpenRTM::PortSharedMemory >, RTC::CorbaConsumer< ::RTC::DataPullService >, RTC::CorbaConsumer< ::RTC::DataPushService >で再実装されています。

参照先 m_objref.

参照元 RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::releaseObject(), ~CorbaConsumerBase().

◆ setObject()

virtual bool RTC::CorbaConsumerBase::setObject ( CORBA::Object_ptr obj )

inlinevirtual

CORBAオブジェクトをセットする

与えられたオブジェクトリファレンスは、ConsumerBase オブジェクト内に CORBA::Object_var 型として保持される。 _var 型変数を引数に渡す場合は var.in() を渡すこと。

引数

obj	CORBA オブジェクトのリファレンス

戻り値: obj が nil リファレンスの場合 false を返す。

RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >, RTC::CorbaConsumer< ::OpenRTM::InPortCdr >, RTC::CorbaConsumer< ::OpenRTM::InPortCdrUDP >, RTC::CorbaConsumer< ::OpenRTM::OutPortCdr >, RTC::CorbaConsumer< ::OpenRTM::PortSharedMemory >, RTC::CorbaConsumer< ::RTC::DataPullService >, RTC::CorbaConsumer< ::RTC::DataPushService >, RTC::InPortSHMConsumer, RTC::OutPortSHMConsumerで再実装されています。

参照先 m_objref.

参照元 RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::setObject().

◆ swap()

void RTC::CorbaConsumerBase::swap ( CorbaConsumerBase & x )

inline

swap関数

引数

x 代入元

参照先 m_objref.

参照元 operator=(), RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::swap().

メンバ詳解

◆ m_objref

CORBA::Object_var RTC::CorbaConsumerBase::m_objref

protected

設定された CORBA オブジェクト

参照元 getObject(), releaseObject(), RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::setObject(), setObject(), swap().

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

CorbaConsumer.h

公開メンバ関数

限定公開変数類

詳解

構築子と解体子

◆ CorbaConsumerBase() [1/2]

◆ CorbaConsumerBase() [2/2]

◆ ~CorbaConsumerBase()

関数詳解

◆ getObject()

◆ operator=()

◆ releaseObject()

◆ setObject()

◆ swap()

メンバ詳解

◆ m_objref