RTC::OutPortDSConsumer Class Reference

OutPortDSConsumer class. More...

#include <OutPortDSConsumer.h>

Inheritance diagram for RTC::OutPortDSConsumer:

Collaboration diagram for RTC::OutPortDSConsumer:

Public Member Functions
	OutPortDSConsumer ()
	Constructor.
	~OutPortDSConsumer () override
	Destructor.
void	init (coil::Properties &prop) override
	Initializing configuration.
void	setBuffer (CdrBufferBase *buffer) override
	Setting outside buffer's pointer.
void	setListener (ConnectorInfo &info, ConnectorListenersBase *listeners) override
	Set the listener.
DataPortStatus	get (ByteData &data) override
	Read data.
bool	subscribeInterface (const SDOPackage::NVList &properties) override
	Subscribe the data receive notification.
void	unsubscribeInterface (const SDOPackage::NVList &properties) override
	Unsubscribe the data receive notification.
Public Member Functions inherited from RTC::OutPortConsumer
virtual	~OutPortConsumer ()=default
	Destructor.
Public Member Functions inherited from RTC::CorbaConsumer< ::RTC::DataPullService >
	CorbaConsumer ()
	Consructor.
	CorbaConsumer (const CorbaConsumer &x)
	Copy constructor.
CorbaConsumer &	operator= (const CorbaConsumer &x)
	Assignment operator.
void	swap (CorbaConsumer &x)
	~CorbaConsumer () override
	Virtual destructor.
bool	setObject (CORBA::Object_ptr obj) override
	Set Object.
typename ::RTC::DataPullService::_ptr_type	_ptr ()
	Get Object reference narrowed as ObjectType.
typename ::RTC::DataPullService::_ptr_type	operator-> ()
	Get Object reference narrowed as ObjectType.
void	releaseObject () override
	Clear CORBA object setting.
Public Member Functions inherited from RTC::CorbaConsumerBase
	CorbaConsumerBase ()=default
	Consructor.
	CorbaConsumerBase (const CorbaConsumerBase &x)
	Copy Consructor.
CorbaConsumerBase &	operator= (const CorbaConsumerBase &x)
	Assignment operator.
void	swap (CorbaConsumerBase &x)
	swap function
virtual	~CorbaConsumerBase ()
	Virtual destructor.
virtual CORBA::Object_ptr	getObject ()
	Get CORBA Object.

Additional Inherited Members
Protected Attributes inherited from RTC::OutPortConsumer
Logger	rtclog
	Logger stream .
Protected Attributes inherited from RTC::CorbaConsumer< ::RTC::DataPullService >
typename ::RTC::DataPullService::_var_type	m_var
	CORBA object which has been set. .
Protected Attributes inherited from RTC::CorbaConsumerBase
CORBA::Object_var	m_objref
	CORBA object which is set. .

Detailed Description

OutPortDSConsumer class.

The OutPort consumer class which uses the RTC::DataPullService interface in CORBA for data transfer and realizes a pull-type dataflow.

Since

2.0.0

Constructor & Destructor Documentation

OutPortDSConsumer()

RTC::OutPortDSConsumer::OutPortDSConsumer

(

)

Constructor.

Constructor

~OutPortDSConsumer()

RTC::OutPortDSConsumer::~OutPortDSConsumer ( )

override

Destructor.

Destructor

Member Function Documentation

get()

DataPortStatus RTC::OutPortDSConsumer::get ( ByteData & data )

overridevirtual

Read data.

Read set data

Parameters

data	Object to receive the read data

Returns

Read result (Successful:true, Failed:false)

Implements RTC::OutPortConsumer.

init()

void RTC::OutPortDSConsumer::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::OutPortConsumer.

setBuffer()

void RTC::OutPortDSConsumer::setBuffer ( CdrBufferBase * 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::OutPortConsumer.

setListener()

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

overridevirtual

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

• ON_BUFFER_WRITE
• ON_BUFFER_FULL
• ON_RECEIVED
• ON_RECEIVER_FULL
• ON_SENDER_EMPTY
• ON_SENDER_TIMEOUT
• ON_SENDER_ERROR

Parameters

info	Connector information
listeners	Listener objects

Implements RTC::OutPortConsumer.

subscribeInterface()

bool RTC::OutPortDSConsumer::subscribeInterface ( const SDOPackage::NVList & properties )

overridevirtual

Subscribe the data receive notification.

Subscribe the data receive notification based on specified property information

Parameters

properties

Subscription information

Returns

Subscription result (Successful:true, Failed:false)

Implements RTC::OutPortConsumer.

unsubscribeInterface()

void RTC::OutPortDSConsumer::unsubscribeInterface ( const SDOPackage::NVList & properties )

overridevirtual

Unsubscribe the data receive notification.

Unsubscribe the data receive notification.

Parameters

properties

Unsubscription information

Implements RTC::OutPortConsumer.

---

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

• OutPortDSConsumer.h