RTC::OutPortCorbaCdrConsumer Class Reference

OutPortCorbaCdrConsumer class. More...

#include <OutPortCorbaCdrConsumer.h>

Inheritance diagram for RTC::OutPortCorbaCdrConsumer:

RTC::OutPortConsumer RTC::CorbaConsumer< ::OpenRTM::OutPortCdr > RTC::DataPortStatus RTC::CorbaConsumerBase

List of all members.

Public Member Functions

DATAPORTSTATUS_ENUM OutPortCorbaCdrConsumer ()
 Constructor.
virtual ~OutPortCorbaCdrConsumer (void)
 Destructor.
virtual void init (coil::Properties &prop)
 Initializing configuration.
virtual void setBuffer (CdrBufferBase *buffer)
 Setting outside buffer's pointer.
virtual void setListener (ConnectorInfo &info, ConnectorListeners *listeners)
 Set the listener.
virtual ReturnCode get (cdrMemoryStream &data)
 Read data.
virtual bool subscribeInterface (const SDOPackage::NVList &properties)
 Subscribe the data receive notification.
virtual void unsubscribeInterface (const SDOPackage::NVList &properties)
 Unsubscribe the data receive notification.


Detailed Description

OutPortCorbaCdrConsumer class.

This is an implementation class of the output Consumer that uses CORBA for means of communication.

Parameters:
DataType Data type for this port
Since:
1.0.0

Constructor & Destructor Documentation

DATAPORTSTATUS_ENUM RTC::OutPortCorbaCdrConsumer::OutPortCorbaCdrConsumer (  ) 

Constructor.

Constructor

Parameters:
buffer Buffer that is attached to this port

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

Destructor.

Destructor


Member Function Documentation

virtual void RTC::OutPortCorbaCdrConsumer::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

Implements RTC::OutPortConsumer.

virtual void RTC::OutPortCorbaCdrConsumer::setBuffer ( CdrBufferBase 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

Implements RTC::OutPortConsumer.

virtual void RTC::OutPortCorbaCdrConsumer::setListener ( ConnectorInfo info,
ConnectorListeners listeners 
) [virtual]

Set the listener.

Implements RTC::OutPortConsumer.

virtual ReturnCode RTC::OutPortCorbaCdrConsumer::get ( cdrMemoryStream &  data  )  [virtual]

Read data.

Read set data

Parameters:
data Object to receive the read data
Returns:
Read result (Successful:true, Failed:false)

Implements RTC::OutPortConsumer.

virtual bool RTC::OutPortCorbaCdrConsumer::subscribeInterface ( const SDOPackage::NVList &  properties  )  [virtual]

Subscribe the data receive notification.

Subscribe the data receive notification based on specified property information

Parameters:
properties Subscription information
Returns:
Subscription result (Successful:true, Failed:false)

Implements RTC::OutPortConsumer.

virtual void RTC::OutPortCorbaCdrConsumer::unsubscribeInterface ( const SDOPackage::NVList &  properties  )  [virtual]

Unsubscribe the data receive notification.

Unsubscribe the data receive notification.

Parameters:
properties Unsubscription information

Implements RTC::OutPortConsumer.


Generated on Thu Jan 28 13:25:36 2010 for OpenRTM by  doxygen 1.5.5