RTC::OutPortCorbaCdrProvider Class Reference

OutPortCorbaCdrProvider class. More...

#include <OutPortCorbaCdrProvider.h>

Inheritance diagram for RTC::OutPortCorbaCdrProvider:

RTC::OutPortProvider RTC::DataPortStatus

List of all members.

Public Member Functions

 OutPortCorbaCdrProvider (void)
 Constructor.
virtual ~OutPortCorbaCdrProvider (void)
 Destructor.
virtual void init (coil::Properties &prop)
 Initializing configuration.
virtual void setBuffer (BufferBase< cdrMemoryStream > *buffer)
 Setting outside buffer's pointer.
virtual
::OpenRTM::PortStatus 
get (::OpenRTM::CdrData_out data)
 [CORBA interface] Get data from the buffer


Detailed Description

OutPortCorbaCdrProvider class.

This is an implementation class of OutPort Provider that uses CORBA for mean of communication.

Parameters:
DataType Data type held by the buffer that is assigned to this provider
Since:
0.4.0

Constructor & Destructor Documentation

RTC::OutPortCorbaCdrProvider::OutPortCorbaCdrProvider ( void   ) 

Constructor.

Constructor

Parameters:
buffer Buffer object that is assigned to this provider

virtual RTC::OutPortCorbaCdrProvider::~OutPortCorbaCdrProvider ( void   )  [virtual]

Destructor.

Destructor


Member Function Documentation

virtual void RTC::OutPortCorbaCdrProvider::init ( coil::Properties &  prop  )  [virtual]

Initializing configuration.

This operation would be called to configure in initialization. In the concrete class, configuration should be performed getting appropriate information from the given Properties data. This function might be called right after instantiation and connection sequence respectivly. Therefore, this function should be implemented assuming multiple call.

Parameters:
prop Configuration information

Reimplemented from RTC::OutPortProvider.

virtual void RTC::OutPortCorbaCdrProvider::setBuffer ( BufferBase< cdrMemoryStream > *  buffer  )  [virtual]

Setting outside buffer's pointer.

A pointer to a buffer from which OutPortProvider retrieve data. If already buffer is set, previous buffer's pointer will be overwritten by the given pointer to a buffer. Since OutPortProvider does not assume ownership of the buffer pointer, destructor of the buffer should be done by user.

Parameters:
buffer A pointer to a data buffer to be used by OutPortProvider

Reimplemented from RTC::OutPortProvider.

virtual ::OpenRTM::PortStatus RTC::OutPortCorbaCdrProvider::get ( ::OpenRTM::CdrData_out  data  ) 

[CORBA interface] Get data from the buffer

Get data from the internal buffer.

Returns:
Data got from the buffer.


Generated on Sun May 24 14:08:45 2009 for OpenRTM by  doxygen 1.5.3