RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar > Class Template Reference

#include <CorbaConsumer.h>

Inheritance diagram for RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >:

Collaboration diagram for RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >:

Public Member Functions
	CorbaConsumer ()
	Consructor.
	CorbaConsumer (const CorbaConsumer &x)
	Copy constructor.
CorbaConsumer &	operator= (const CorbaConsumer &x)
	Assignment operator.
void	swap (CorbaConsumer &x)
	~CorbaConsumer () override
	Virtual destructor.
bool	setObject (CORBA::Object_ptr obj) override
	Set Object.
ObjectTypePtr	_ptr ()
	Get Object reference narrowed as ObjectType.
ObjectTypePtr	operator-> ()
	Get Object reference narrowed as ObjectType.
void	releaseObject () override
	Clear CORBA object setting.
Public Member Functions inherited from RTC::CorbaConsumerBase
	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 CORBA::Object_ptr	getObject ()
	Get CORBA Object.

Protected Attributes
ObjectTypeVar	m_var
	CORBA object which has been set. .
Protected Attributes inherited from RTC::CorbaConsumerBase
CORBA::Object_var	m_objref
	CORBA object which is set. .

Constructor & Destructor Documentation

CorbaConsumer() [1/2]

template<class T , class U , class V >

RTC::CorbaConsumer< T, U, V >::CorbaConsumer ( )

default

Consructor.

CorbaConsumer() [2/2]

template<class ObjectType , typename ObjectTypePtr = typename ObjectType::_ptr_type, typename ObjectTypeVar = typename ObjectType::_var_type>

RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::CorbaConsumer ( const CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar > & x )

inline

Copy constructor.

Parameters

x	Copy source.

~CorbaConsumer()

template<class ObjectType , typename ObjectTypePtr = typename ObjectType::_ptr_type, typename ObjectTypeVar = typename ObjectType::_var_type>

RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::~CorbaConsumer ( )

inlineoverride

Virtual destructor.

References RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::releaseObject().

Member Function Documentation

_ptr()

template<class ObjectType , typename ObjectTypePtr = typename ObjectType::_ptr_type, typename ObjectTypeVar = typename ObjectType::_var_type>

ObjectTypePtr RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::_ptr ( )

inline

Get Object reference narrowed as ObjectType.

This operation returns object reference narrowed as ObjectType. To use the returned object reference, reference have to be set by setObject(). If object is not set, this operation returns nil object reference.

Returns

The object reference narrowed as ObjectType

References RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::m_var.

operator->()

template<class ObjectType , typename ObjectTypePtr = typename ObjectType::_ptr_type, typename ObjectTypeVar = typename ObjectType::_var_type>

ObjectTypePtr RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::operator-> ( )

inline

Get Object reference narrowed as ObjectType.

This operation returns object reference narrowed as ObjectType. To use the returned object reference, reference have to be set by setObject(). If object is not set, this operation returns nil object reference.

Returns

The object reference narrowed as ObjectType

References RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::m_var.

operator=()

template<class ObjectType , typename ObjectTypePtr = typename ObjectType::_ptr_type, typename ObjectTypeVar = typename ObjectType::_var_type>

CorbaConsumer & RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::operator= ( const CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar > & x )

inline

Assignment operator.

Parameters

x	Copy source.

Returns

An assignment result

References RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::swap().

releaseObject()

template<class ObjectType , typename ObjectTypePtr = typename ObjectType::_ptr_type, typename ObjectTypeVar = typename ObjectType::_var_type>

void RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::releaseObject ( )

inlineoverridevirtual

Clear CORBA object setting.

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

Reimplemented from RTC::CorbaConsumerBase.

References RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::m_var, and RTC::CorbaConsumerBase::releaseObject().

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

setObject()

template<class ObjectType , typename ObjectTypePtr = typename ObjectType::_ptr_type, typename ObjectTypeVar = typename ObjectType::_var_type>

bool RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::setObject ( CORBA::Object_ptr obj )

inlineoverridevirtual

Set Object.

Override function of ConsumerBase. This operation set an Object to CORBA:Object_var in the class, and this object is narrowed to given template parameter and stored in the member variable.

Parameters

obj	CORBA Objecct

Returns

An object setting result. If target object is null, it returns false.

Reimplemented from RTC::CorbaConsumerBase.

Reimplemented in RTC::InPortSHMConsumer, and RTC::OutPortSHMConsumer.

References RTC::CorbaConsumerBase::m_objref, RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::m_var, RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::releaseObject(), and RTC::CorbaConsumerBase::setObject().

swap()

template<class ObjectType , typename ObjectTypePtr = typename ObjectType::_ptr_type, typename ObjectTypeVar = typename ObjectType::_var_type>

void RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::swap ( CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar > & x )

inline

References RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::m_var, and RTC::CorbaConsumerBase::swap().

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

Member Data Documentation

m_var

template<class ObjectType , typename ObjectTypePtr = typename ObjectType::_ptr_type, typename ObjectTypeVar = typename ObjectType::_var_type>

ObjectTypeVar RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::m_var

protected

CORBA object which has been set. .

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

---

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

• CorbaConsumer.h