RTC::CorbaConsumerBase Class Reference

#include <CorbaConsumer.h>

Inheritance diagram for RTC::CorbaConsumerBase:

Public Member Functions
	CorbaConsumerBase ()=default
	Consructor.
	CorbaConsumerBase (const CorbaConsumerBase &x)
	Copy Consructor.
CorbaConsumerBase &	operator= (const CorbaConsumerBase &x)
	Assignment operator.
void	swap (CorbaConsumerBase &x)
	swap function
virtual	~CorbaConsumerBase ()
	Virtual destructor.
virtual bool	setObject (CORBA::Object_ptr obj)
	Set CORBA Object.
virtual CORBA::Object_ptr	getObject ()
	Get CORBA Object.
virtual void	releaseObject ()
	Clear CORBA object setting.

Protected Attributes
CORBA::Object_var	m_objref
	CORBA object which is set. .

Constructor & Destructor Documentation

CorbaConsumerBase() [1/2]

RTC::CorbaConsumerBase::CorbaConsumerBase ( )

default

Consructor.

CorbaConsumerBase() [2/2]

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

inline

Copy Consructor.

Parameters

x	A CorbaConsumerBase object of copy source

~CorbaConsumerBase()

virtual RTC::CorbaConsumerBase::~CorbaConsumerBase ( )

inlinevirtual

Virtual destructor.

References releaseObject().

Member Function Documentation

getObject()

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

inlinevirtual

Get CORBA Object.

Get the object reference held as CORBA::Object_var type in ConsumerBase object.

Returns

Object reference of CORBA object

References m_objref.

operator=()

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

inline

Assignment operator.

Parameters

x	Copy source.

Returns

An assignment result

References swap().

releaseObject()

virtual void RTC::CorbaConsumerBase::releaseObject ( )

inlinevirtual

Clear CORBA object setting.

Clear CORBA object which is set. Operate nothing for CORBA object itself.

Reimplemented in 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 >, and RTC::CorbaConsumer< ::RTC::DataPushService >.

References m_objref.

Referenced by RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::releaseObject(), and ~CorbaConsumerBase().

setObject()

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

inlinevirtual

Set CORBA Object.

The given CORBA Object is held as CORBA::Object_var type in ConsumerBase object.

Parameters

obj	Object reference of CORBA object

Returns

If obj is nil reference, it returns false.

Reimplemented in 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, and RTC::OutPortSHMConsumer.

References m_objref.

Referenced by RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::setObject().

swap()

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

inline

swap function

Parameters

x	Copy source.

References m_objref.

Referenced by operator=(), and RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::swap().

Member Data Documentation

m_objref

CORBA::Object_var RTC::CorbaConsumerBase::m_objref

protected

CORBA object which is set. .

Referenced by getObject(), releaseObject(), RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::setObject(), setObject(), and swap().

---

The documentation for this class was generated from the following file:

• CorbaConsumer.h