#include <OutPortCorbaCdrProvider.h>

Inheritance diagram for RTC::OutPortCorbaCdrProvider:

Public Member Functions
virtual ::OpenRTM::PortStatus	get (::OpenRTM::CdrData_out data) throw (CORBA::SystemException)
	[CORBA interface] Get data from the buffer
virtual void	init (coil::Properties &prop)
	Initializing configuration.
	OutPortCorbaCdrProvider (void)
	Constructor.
virtual void	setBuffer (CdrBufferBase *buffer)
	Setting outside buffer's pointer.
virtual void	setConnector (OutPortConnector *connector)
	set Connector
virtual void	setListener (ConnectorInfo &info, ConnectorListeners *listeners)
	Set the listener.
virtual	~OutPortCorbaCdrProvider (void)
	Destructor.
Private Member Functions
::OpenRTM::PortStatus	convertReturn (BufferStatus::Enum status, const cdrMemoryStream &data)
	Return codes conversion.
void	onBufferEmpty ()
	Notify an ON_BUFFER_EMPTY event to listeners.
void	onBufferRead (const cdrMemoryStream &data)
	Notify an ON_BUFFER_READ event to listeners.
void	onBufferReadTimeout ()
	Notify an ON_BUFFER_READ_TIMEOUT event to listeners.
void	onSend (const cdrMemoryStream &data)
	Notify an ON_SEND event to listeners.
void	onSenderEmpty ()
	Notify an ON_SENDER_EMPTY event to listeners.
void	onSenderError ()
	Notify an ON_SENDER_ERROR event to listeners.
void	onSenderTimeout ()
	Notify an ON_SENDER_TIMEOUT event to listeners.
Private Attributes
CdrBufferBase *	m_buffer
OutPortConnector *	m_connector
ConnectorListeners *	m_listeners
::OpenRTM::OutPortCdr_var	m_objref
ConnectorInfo	m_profile

Detailed Description

OutPortCorbaCdrProvider class.

The OutPort provider class which uses the OpenRTM::OutPortCdr interface in CORBA for data transfer and realizes a pull-type dataflow.

Since:: 0.4.0

Definition at line 61 of file OutPortCorbaCdrProvider.h.

Constructor & Destructor Documentation

RTC::OutPortCorbaCdrProvider::OutPortCorbaCdrProvider ( void )

Constructor.

Constructor

Definition at line 35 of file OutPortCorbaCdrProvider.cpp.

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

Destructor.

Destructor

Definition at line 68 of file OutPortCorbaCdrProvider.cpp.

Member Function Documentation

OpenRTM::PortStatus RTC::OutPortCorbaCdrProvider::convertReturn	(	BufferStatus::Enum	status,
		const cdrMemoryStream &	data
	)		`[private]`

Return codes conversion.

Definition at line 193 of file OutPortCorbaCdrProvider.cpp.

OpenRTM::PortStatus RTC::OutPortCorbaCdrProvider::get ( ::OpenRTM::CdrData_out data ) throw (CORBA::SystemException)

[CORBA interface] Get data from the buffer

Get data from the internal buffer.

Returns:: Data got from the buffer.

Definition at line 148 of file OutPortCorbaCdrProvider.cpp.

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.

Definition at line 98 of file OutPortCorbaCdrProvider.cpp.

void RTC::OutPortCorbaCdrProvider::onBufferEmpty ( ) [inline, private]

Notify an ON_BUFFER_EMPTY event to listeners.

Definition at line 296 of file OutPortCorbaCdrProvider.h.

void RTC::OutPortCorbaCdrProvider::onBufferRead ( const cdrMemoryStream & data ) [inline, private]

Notify an ON_BUFFER_READ event to listeners.

Parameters:

data	cdrMemoryStream

Definition at line 268 of file OutPortCorbaCdrProvider.h.

void RTC::OutPortCorbaCdrProvider::onBufferReadTimeout ( ) [inline, private]

Notify an ON_BUFFER_READ_TIMEOUT event to listeners.

Definition at line 309 of file OutPortCorbaCdrProvider.h.

void RTC::OutPortCorbaCdrProvider::onSend ( const cdrMemoryStream & data ) [inline, private]

Notify an ON_SEND event to listeners.

Parameters:

data	cdrMemoryStream

Definition at line 283 of file OutPortCorbaCdrProvider.h.

void RTC::OutPortCorbaCdrProvider::onSenderEmpty ( ) [inline, private]

Notify an ON_SENDER_EMPTY event to listeners.

Definition at line 322 of file OutPortCorbaCdrProvider.h.

void RTC::OutPortCorbaCdrProvider::onSenderError ( ) [inline, private]

Notify an ON_SENDER_ERROR event to listeners.

Definition at line 348 of file OutPortCorbaCdrProvider.h.

void RTC::OutPortCorbaCdrProvider::onSenderTimeout ( ) [inline, private]

Notify an ON_SENDER_TIMEOUT event to listeners.

Definition at line 335 of file OutPortCorbaCdrProvider.h.

void RTC::OutPortCorbaCdrProvider::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::OutPortProvider.

Definition at line 109 of file OutPortCorbaCdrProvider.cpp.

void RTC::OutPortCorbaCdrProvider::setConnector ( OutPortConnector * connector ) [virtual]

set Connector

Setting outside connector's pointer.

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

Parameters:

connector OutPortConnector

Implements RTC::OutPortProvider.

Definition at line 135 of file OutPortCorbaCdrProvider.cpp.

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

Set the listener.

OutPort 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 OutPortCorbaCdrProvider provides the following callbacks.