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

#include <CorbaConsumer.h>

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

List of all members.

Public Member Functions
ObjectTypePtr	_ptr ()
	Get Object reference narrowed as ObjectType.
	CorbaConsumer ()
	Consructor.
	CorbaConsumer (const CorbaConsumer &x)
	Copy constructor.
ObjectTypePtr	operator-> ()
	Get Object reference narrowed as ObjectType.
CorbaConsumer &	operator= (const CorbaConsumer &x)
	Assignment operator.
virtual void	releaseObject ()
	Clear CORBA object setting.
virtual bool	setObject (CORBA::Object_ptr obj)
	Set Object.
void	swap (CorbaConsumer &x)
virtual	~CorbaConsumer (void)
	Virtual destructor.
Protected Attributes
ObjectTypeVar	m_var
	CORBA object which has been set.

---

Detailed Description

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

Definition at line 338 of file CorbaConsumer.h.

---

Constructor & Destructor Documentation

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

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

(

)

[inline]

Consructor.

Definition at line 353 of file CorbaConsumer.h.

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.

Definition at line 370 of file CorbaConsumer.h.

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

virtual RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::~CorbaConsumer

(

void

)

[inline, virtual]

Virtual destructor.

Definition at line 421 of file CorbaConsumer.h.

---

Member Function Documentation

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

Definition at line 498 of file CorbaConsumer.h.

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

Definition at line 527 of file CorbaConsumer.h.

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

Definition at line 394 of file CorbaConsumer.h.

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

virtual void RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::releaseObject

(

)

[inline, virtual]

Clear CORBA object setting.

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

Reimplemented from RTC::CorbaConsumerBase.

Definition at line 549 of file CorbaConsumer.h.

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

virtual bool RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >::setObject

(

CORBA::Object_ptr

obj

)

[inline, virtual]

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.

Definition at line 454 of file CorbaConsumer.h.

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]

Definition at line 401 of file CorbaConsumer.h.

---

Member Data Documentation

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.

Definition at line 563 of file CorbaConsumer.h.

---

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

• CorbaConsumer.h