Public Member Functions | Protected Attributes | List of all members
RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar > Class Template Reference

#include <CorbaConsumer.h>

Inheritance diagram for RTC::CorbaConsumer< ObjectType, ObjectTypePtr, ObjectTypeVar >:
Inheritance graph
[legend]

Public Member Functions

ObjectTypePtr _ptr ()
 Get Object reference narrowed as ObjectType. More...
 
 CorbaConsumer ()
 Consructor. More...
 
 CorbaConsumer (const CorbaConsumer &x)
 Copy constructor. More...
 
ObjectTypePtr operator-> ()
 Get Object reference narrowed as ObjectType. More...
 
CorbaConsumeroperator= (const CorbaConsumer &x)
 Assignment operator. More...
 
virtual void releaseObject ()
 Clear CORBA object setting. More...
 
virtual bool setObject (CORBA::Object_ptr obj)
 Set Object. More...
 
void swap (CorbaConsumer &x)
 
virtual ~CorbaConsumer (void)
 Virtual destructor. More...
 
- Public Member Functions inherited from RTC::CorbaConsumerBase
 CorbaConsumerBase ()
 Consructor. More...
 
 CorbaConsumerBase (const CorbaConsumerBase &x)
 Copy Consructor. More...
 
virtual CORBA::Object_ptr getObject ()
 Get CORBA Object. More...
 
CorbaConsumerBaseoperator= (const CorbaConsumerBase &x)
 Assignment operator. More...
 
void swap (CorbaConsumerBase &x)
 swap function More...
 
virtual ~CorbaConsumerBase (void)
 Virtual destructor. More...
 

Protected Attributes

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

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
xCopy 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  )
inlinevirtual

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
xCopy 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 ( )
inlinevirtual

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)
inlinevirtual

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
objCORBA 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:


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Mon Jun 10 2019 14:08:03