#include <InPortCorbaCdrProvider.h>

Inheritance diagram for RTC::InPortCorbaCdrProvider:

Public Member Functions
virtual void	init (coil::Properties &prop)
	Initializing configuration. More...

	InPortCorbaCdrProvider (void)
	Constructor. More...

virtual ::OpenRTM::PortStatus	put (const ::OpenRTM::CdrData &data) throw (CORBA::SystemException)
	[CORBA interface] Write data into the buffer More...

virtual void	setBuffer (BufferBase< cdrMemoryStream > *buffer)
	Setting outside buffer's pointer. More...

virtual void	setConnector (InPortConnector *connector)
	set Connector More...

virtual void	setListener (ConnectorInfo &info, ConnectorListeners *listeners)
	Set the listener. More...

virtual	~InPortCorbaCdrProvider (void)
	Destructor. More...

Public Member Functions inherited from RTC::InPortProvider
DATAPORTSTATUS_ENUM	InPortProvider ()
	Constructor. More...

virtual bool	publishInterface (SDOPackage::NVList &properties)
	Publish interface information. More...

virtual void	publishInterfaceProfile (SDOPackage::NVList &properties)
	Publish InterfaceProfile information. More...

virtual	~InPortProvider (void)
	Destructor. More...

Private Member Functions
::OpenRTM::PortStatus	convertReturn (BufferStatus::Enum status, const cdrMemoryStream &data)
	Return codes conversion. More...

void	onBufferFull (const cdrMemoryStream &data)
	Notify an ON_BUFFER_FULL event to listeners. More...

void	onBufferWrite (const cdrMemoryStream &data)
	Notify an ON_BUFFER_WRITE event to listeners. More...

void	onBufferWriteOverwrite (const cdrMemoryStream &data)
	Notify an ON_BUFFER_WRITE_OVERWRITE event to listeners. More...

void	onBufferWriteTimeout (const cdrMemoryStream &data)
	Notify an ON_BUFFER_WRITE_TIMEOUT event to listeners. More...

void	onReceived (const cdrMemoryStream &data)
	Notify an ON_RECEIVED event to listeners. More...

void	onReceiverError (const cdrMemoryStream &data)

void	onReceiverFull (const cdrMemoryStream &data)
	Notify an ON_RECEIVER_FULL event to listeners. More...

void	onReceiverTimeout (const cdrMemoryStream &data)
	Notify an ON_RECEIVER_TIMEOUT event to listeners. More...

Private Attributes
CdrBufferBase *	m_buffer

InPortConnector *	m_connector

ConnectorListeners *	m_listeners

::OpenRTM::InPortCdr_var	m_objref

ConnectorInfo	m_profile

Additional Inherited Members
Public Types inherited from RTC::DataPortStatus
enum	Enum { PORT_OK = 0, PORT_ERROR, BUFFER_ERROR, BUFFER_FULL, BUFFER_EMPTY, BUFFER_TIMEOUT, SEND_FULL, SEND_TIMEOUT, RECV_EMPTY, RECV_TIMEOUT, INVALID_ARGS, PRECONDITION_NOT_MET, CONNECTION_LOST, UNKNOWN_ERROR }
	DataPortStatus return codes. More...

Static Public Member Functions inherited from RTC::DataPortStatus
static const char *	toString (DataPortStatus::Enum status)
	Convert DataPortStatus into the string. More...

Protected Member Functions inherited from RTC::InPortProvider
void	setDataFlowType (const char *dataflow_type)
	Set the dataflow type. More...

void	setInterfaceType (const char *interface_type)
	Set the interface type. More...

void	setSubscriptionType (const char *subs_type)
	Set the subscription type. More...

Protected Attributes inherited from RTC::InPortProvider
SDOPackage::NVList	m_properties
	Properties to hold port profile. More...

Logger	rtclog
	Logger stream. More...

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

Definition at line 61 of file InPortCorbaCdrProvider.h.

Constructor & Destructor Documentation

◆ InPortCorbaCdrProvider()

RTC::InPortCorbaCdrProvider::InPortCorbaCdrProvider ( void )

Constructor.

Constructor

Definition at line 35 of file InPortCorbaCdrProvider.cpp.

◆ ~InPortCorbaCdrProvider()

RTC::InPortCorbaCdrProvider::~InPortCorbaCdrProvider ( void )

virtual

Destructor.

Destructor

Definition at line 62 of file InPortCorbaCdrProvider.cpp.

Member Function Documentation

◆ convertReturn()

OpenRTM::PortStatus RTC::InPortCorbaCdrProvider::convertReturn	(	BufferStatus::Enum	status,
		const cdrMemoryStream &	data
	)

private

Return codes conversion.

Definition at line 172 of file InPortCorbaCdrProvider.cpp.

◆ init()

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.

Definition at line 85 of file InPortCorbaCdrProvider.cpp.

◆ onBufferFull()

void RTC::InPortCorbaCdrProvider::onBufferFull ( const cdrMemoryStream & data )

inlineprivate

Notify an ON_BUFFER_FULL event to listeners.

Parameters

data	cdrMemoryStream

Definition at line 287 of file InPortCorbaCdrProvider.h.

◆ onBufferWrite()

void RTC::InPortCorbaCdrProvider::onBufferWrite ( const cdrMemoryStream & data )

inlineprivate

Notify an ON_BUFFER_WRITE event to listeners.

Parameters

data	cdrMemoryStream

Definition at line 272 of file InPortCorbaCdrProvider.h.

◆ onBufferWriteOverwrite()

void RTC::InPortCorbaCdrProvider::onBufferWriteOverwrite ( const cdrMemoryStream & data )

inlineprivate

Notify an ON_BUFFER_WRITE_OVERWRITE event to listeners.

Parameters

data	cdrMemoryStream

Definition at line 317 of file InPortCorbaCdrProvider.h.

◆ onBufferWriteTimeout()

void RTC::InPortCorbaCdrProvider::onBufferWriteTimeout ( const cdrMemoryStream & data )

inlineprivate

Notify an ON_BUFFER_WRITE_TIMEOUT event to listeners.

Parameters

data	cdrMemoryStream

Definition at line 302 of file InPortCorbaCdrProvider.h.

◆ onReceived()

void RTC::InPortCorbaCdrProvider::onReceived ( const cdrMemoryStream & data )

inlineprivate

Notify an ON_RECEIVED event to listeners.

Parameters

data	cdrMemoryStream

Definition at line 332 of file InPortCorbaCdrProvider.h.

◆ onReceiverError()

void RTC::InPortCorbaCdrProvider::onReceiverError ( const cdrMemoryStream & data )

inlineprivate

Notify an ON_RECEIVER_ERROR event to listeners

Definition at line 373 of file InPortCorbaCdrProvider.h.

◆ onReceiverFull()

void RTC::InPortCorbaCdrProvider::onReceiverFull ( const cdrMemoryStream & data )

inlineprivate

Notify an ON_RECEIVER_FULL event to listeners.

Parameters

data	cdrMemoryStream

Definition at line 347 of file InPortCorbaCdrProvider.h.

◆ onReceiverTimeout()

void RTC::InPortCorbaCdrProvider::onReceiverTimeout ( const cdrMemoryStream & data )

inlineprivate

Notify an ON_RECEIVER_TIMEOUT event to listeners.

Definition at line 360 of file InPortCorbaCdrProvider.h.

◆ put()

OpenRTM::PortStatus RTC::InPortCorbaCdrProvider::put	(	const ::OpenRTM::CdrData &	data	)
throw	(	CORBA::SystemException
	)

[CORBA interface] Write data into the buffer

Write data into the buffer.

Write data into the specified buffer.

Parameters

data	The target data for writing

Definition at line 136 of file InPortCorbaCdrProvider.cpp.

◆ setBuffer()

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.

Definition at line 97 of file InPortCorbaCdrProvider.cpp.

◆ setConnector()

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.

Definition at line 123 of file InPortCorbaCdrProvider.cpp.

◆ setListener()

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.

Definition at line 109 of file InPortCorbaCdrProvider.cpp.

Member Data Documentation

◆ m_buffer

CdrBufferBase* RTC::InPortCorbaCdrProvider::m_buffer

private

Definition at line 380 of file InPortCorbaCdrProvider.h.

◆ m_connector

InPortConnector* RTC::InPortCorbaCdrProvider::m_connector

private

Definition at line 384 of file InPortCorbaCdrProvider.h.

◆ m_listeners

ConnectorListeners* RTC::InPortCorbaCdrProvider::m_listeners

private

Definition at line 382 of file InPortCorbaCdrProvider.h.

◆ m_objref

::OpenRTM::InPortCdr_var RTC::InPortCorbaCdrProvider::m_objref

private

Definition at line 381 of file InPortCorbaCdrProvider.h.

◆ m_profile

ConnectorInfo RTC::InPortCorbaCdrProvider::m_profile

private

Definition at line 383 of file InPortCorbaCdrProvider.h.

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ InPortCorbaCdrProvider()

◆ ~InPortCorbaCdrProvider()

Member Function Documentation

◆ convertReturn()

◆ init()

◆ onBufferFull()

◆ onBufferWrite()

◆ onBufferWriteOverwrite()

◆ onBufferWriteTimeout()

◆ onReceived()

◆ onReceiverError()

◆ onReceiverFull()

◆ onReceiverTimeout()

◆ put()

◆ setBuffer()

◆ setConnector()

◆ setListener()

Member Data Documentation

◆ m_buffer

◆ m_connector

◆ m_listeners

◆ m_objref

◆ m_profile