RTC::InPortDirectProvider Class Reference

InPortDirectProvider class. More...

#include <InPortDirectProvider.h>

Inheritance diagram for RTC::InPortDirectProvider:

Collaboration diagram for RTC::InPortDirectProvider:

Public Member Functions
	InPortDirectProvider (void)
	Constructor. More...
virtual	~InPortDirectProvider (void)
	Destructor. More...
virtual void	init (coil::Properties &prop)
	Initializing configuration. More...
virtual void	setBuffer (BufferBase< cdrMemoryStream > *buffer)
	Setting outside buffer's pointer. More...
virtual void	setListener (ConnectorInfo &info, ConnectorListeners *listeners)
	Set the listener. More...
virtual void	setConnector (InPortConnector *connector)
	set Connector More...
Public Member Functions inherited from RTC::InPortProvider
DATAPORTSTATUS_ENUM	InPortProvider ()
	Constructor. More...
virtual	~InPortProvider (void)
	Destructor. More...
virtual void	publishInterfaceProfile (SDOPackage::NVList &properties)
	Publish InterfaceProfile information. More...
virtual bool	publishInterface (SDOPackage::NVList &properties)
	Publish interface information. More...

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	setInterfaceType (const char *interface_type)
	Set the interface type. More...
void	setDataFlowType (const char *dataflow_type)
	Set the dataflow 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

InPortDirectProvider 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::InPortDirectProvider::InPortDirectProvider

(

void

)

Constructor.

Constructor

virtual RTC::InPortDirectProvider::~InPortDirectProvider ( void  )

virtual

Destructor.

Destructor

Member Function Documentation

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

---

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

• InPortDirectProvider.h