RTC::InPortDSProvider Class Reference

InPortDSProvider class. More...

#include <InPortDSProvider.h>

Inheritance diagram for RTC::InPortDSProvider:

Collaboration diagram for RTC::InPortDSProvider:

Public Member Functions
	InPortDSProvider ()
	Constructor.
	~InPortDSProvider () override
	Destructor.
void	init (coil::Properties &prop) override
	Initializing configuration.
void	setBuffer (BufferBase< ByteData > *buffer) override
	Setting outside buffer's pointer.
void	setListener (ConnectorInfo &info, ConnectorListenersBase *listeners) override
	Set the listener.
void	setConnector (InPortConnector *connector) override
	set Connector
::RTC::PortStatus	push (const ::RTC::OctetSeq &data) override
	[CORBA interface] Write data into the buffer
Public Member Functions inherited from RTC::InPortProvider
	InPortProvider ()
	Constructor.
virtual	~InPortProvider ()
	Destructor.
virtual void	publishInterfaceProfile (SDOPackage::NVList &prop)
	Publish InterfaceProfile information.
virtual bool	publishInterface (SDOPackage::NVList &prop)
	Publish interface information.

Additional Inherited Members
Protected Member Functions inherited from RTC::InPortProvider
void	setInterfaceType (const char *interface_type)
	Set the interface type.
void	setDataFlowType (const char *dataflow_type)
	Set the dataflow type.
void	setSubscriptionType (const char *subs_type)
	Set the subscription type.
Protected Attributes inherited from RTC::InPortProvider
SDOPackage::NVList	m_properties
	Properties to hold port profile .
Logger	rtclog
	Logger stream .

Detailed Description

InPortDSProvider class.

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

Since

2.0.0

Constructor & Destructor Documentation

InPortDSProvider()

RTC::InPortDSProvider::InPortDSProvider

(

)

Constructor.

Constructor

~InPortDSProvider()

RTC::InPortDSProvider::~InPortDSProvider ( )

override

Destructor.

Destructor

Member Function Documentation

init()

void RTC::InPortDSProvider::init ( coil::Properties & prop )

overridevirtual

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.

push()

::RTC::PortStatus RTC::InPortDSProvider::push ( const ::RTC::OctetSeq & data )

override

[CORBA interface] Write data into the buffer

Write data into the specified buffer.

Parameters

data	The target data for writing

setBuffer()

void RTC::InPortDSProvider::setBuffer ( BufferBase< ByteData > * buffer )

overridevirtual

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.

setConnector()

void RTC::InPortDSProvider::setConnector ( InPortConnector * connector )

overridevirtual

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.

setListener()

void RTC::InPortDSProvider::setListener ( ConnectorInfo & info, ConnectorListenersBase * listeners )

overridevirtual

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

• InPortDSProvider.h