RTC::InPortCorbaCdrProvider Class Reference

InPortCorbaCdrProvider class. More...

#include <InPortCorbaCdrProvider.h>

Inheritance diagram for RTC::InPortCorbaCdrProvider:

List of all members.

Public Member Functions
	InPortCorbaCdrProvider (void)
	Constructor.
virtual	~InPortCorbaCdrProvider (void)
	Destructor.
virtual void	init (coil::Properties &prop)
	Initializing configuration.
virtual void	setBuffer (BufferBase< cdrMemoryStream > *buffer)
	Setting outside buffer's pointer.
virtual void	setListener (ConnectorInfo &info, ConnectorListeners *listeners)
	Set the listener.
virtual void	setConnector (InPortConnector *connector)
	set Connector
virtual ::OpenRTM::PortStatus	put (const ::OpenRTM::CdrData &data) throw (CORBA::SystemException)
	[CORBA interface] Write data into the buffer

---

Detailed Description

InPortCorbaCdrProvider class.

The InPort provider class which uses the OpenRTM::InPortCdr interface in CORBA for data transfer and realizes a push-type dataflow.

Since:

0.4.0

---

Constructor & Destructor Documentation

RTC::InPortCorbaCdrProvider::InPortCorbaCdrProvider

(

void

)

Constructor.

Constructor

virtual RTC::InPortCorbaCdrProvider::~InPortCorbaCdrProvider

(

void

)

[virtual]

Destructor.

Destructor

---

Member Function Documentation

virtual void RTC::InPortCorbaCdrProvider::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::InPortProvider.

virtual ::OpenRTM::PortStatus RTC::InPortCorbaCdrProvider::put

(

const ::OpenRTM::CdrData &

data

)

throw (CORBA::SystemException)

[CORBA interface] Write data into the buffer

Write data into the specified buffer.

Parameters:

data

The target data for writing

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

Implements RTC::InPortProvider.

virtual void RTC::InPortCorbaCdrProvider::setConnector

(

InPortConnector *

connector

)

[virtual]

set Connector

InPort creates InPortConnector object when it establishes connection between InPort and InPort, and it calls this function with a pointer to the connector object. Since the InPort has the ownership of this connector, InPortProvider should not delete it.

Parameters:

connector

InPortConnector

Implements RTC::InPortProvider.

virtual void RTC::InPortCorbaCdrProvider::setListener	(	ConnectorInfo &	info,
		ConnectorListeners *	listeners
	)			[virtual]

Set the listener.

InPort provides callback functionality that calls specific listener objects according to the events in the data publishing process. For details, see documentation of ConnectorDataListener class and ConnectorListener class in ConnectorListener.h. In this InPortCorbaCdrProvider provides the following callbacks.

• ON_BUFFER_WRITE
• ON_BUFFER_FULL
• ON_BUFFER_WRITE_TIMEOUT
• ON_BUFFER_OVERWRITE
• ON_RECEIVED
• ON_RECEIVER_FULL
• ON_RECEIVER_FULL
• ON_RECEIVER_TIMEOUT
• ON_RECEIVER_ERROR

Parameters:

	info	Connector information
	listeners	Listener objects

Implements RTC::InPortProvider.