RTC::OutPortDirectProvider Class Reference

OutPortDirectProvider class. More...

#include <OutPortDirectProvider.h>

Inheritance diagram for RTC::OutPortDirectProvider:

Collaboration diagram for RTC::OutPortDirectProvider:

Public Member Functions
	OutPortDirectProvider (void)
	Constructor. More...
virtual	~OutPortDirectProvider (void)
	Destructor. More...
virtual void	init (coil::Properties &prop)
	Initializing configuration. More...
virtual void	setBuffer (CdrBufferBase *buffer)
	Setting outside buffer's pointer. More...
virtual void	setListener (ConnectorInfo &info, ConnectorListeners *listeners)
	Set the listener. More...
virtual void	setConnector (OutPortConnector *connector)
	set Connector More...
Public Member Functions inherited from RTC::OutPortProvider
virtual DATAPORTSTATUS_ENUM	~OutPortProvider (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::OutPortProvider
void	setPortType (const char *port_type)
	Set the port type. More...
void	setDataType (const char *data_type)
	Set the data type. More...
void	setInterfaceType (const char *interface_type)
	Set the interface type. More...
void	setDataFlowType (const char *dataflow_type)
	Set the data flow type. More...
void	setSubscriptionType (const char *subs_type)
	Set the subscription type. More...
Protected Attributes inherited from RTC::OutPortProvider
SDOPackage::NVList	m_properties
	Properties to hold the port profiles. More...
Logger	rtclog
	Logger stream. More...

Detailed Description

OutPortDirectProvider class.

Since

1.2.0

Constructor & Destructor Documentation

RTC::OutPortDirectProvider::OutPortDirectProvider

(

void

)

Constructor.

Constructor

virtual RTC::OutPortDirectProvider::~OutPortDirectProvider ( void  )

virtual

Destructor.

Destructor

Member Function Documentation

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

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

virtual void RTC::OutPortDirectProvider::setConnector ( OutPortConnector *  connector )

virtual

set Connector

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.

virtual void RTC::OutPortDirectProvider::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 OutPortDirectProvider provides the following callbacks.

• ON_BUFFER_READ
• ON_SEND
• ON_BUFFER_EMPTY
• ON_BUFFER_READ_TIMEOUT
• ON_SENDER_EMPTY
• ON_SENDER_TIMEOUT
• ON_SENDER_ERROR

Parameters

info	Connector information
listeners	Listener objects

Implements RTC::OutPortProvider.

---

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

• OutPortDirectProvider.h