RTC::InPortDirectConsumer Class Reference

InPortDirectConsumer class. More...

#include <InPortDirectConsumer.h>

Inheritance diagram for RTC::InPortDirectConsumer:

Collaboration diagram for RTC::InPortDirectConsumer:

Public Member Functions
	InPortDirectConsumer ()
	Constructor.
	~InPortDirectConsumer () override
	Destructor.
void	init (coil::Properties &prop) override
	Initializing configuration.
DataPortStatus	put (ByteData &data) override
	Send data to the destination port.
void	publishInterfaceProfile (SDOPackage::NVList &properties) override
	Publish InterfaceProfile information.
bool	subscribeInterface (const SDOPackage::NVList &properties) override
	Subscribe to the data sending notification.
void	unsubscribeInterface (const SDOPackage::NVList &properties) override
	Unsubscribe the data send notification.
Public Member Functions inherited from RTC::InPortConsumer
virtual	~InPortConsumer ()=default
	Destructor.

Detailed Description

InPortDirectConsumer class.

The InPort consumer 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

InPortDirectConsumer()

RTC::InPortDirectConsumer::InPortDirectConsumer

(

)

Constructor.

Constructor

Parameters

buffer

The buffer object that is attached to this Consumer

~InPortDirectConsumer()

RTC::InPortDirectConsumer::~InPortDirectConsumer ( )

override

Destructor.

Destructor

Member Function Documentation

init()

void RTC::InPortDirectConsumer::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::InPortConsumer.

publishInterfaceProfile()

void RTC::InPortDirectConsumer::publishInterfaceProfile ( SDOPackage::NVList & properties )

overridevirtual

Publish InterfaceProfile information.

Publish interfaceProfile information. Check the dataport.interface_type value of the NameValue object specified by an argument in property information and get information only when the interface type of the specified port is matched.

Parameters

properties

Properties to get InterfaceProfile information

Implements RTC::InPortConsumer.

put()

DataPortStatus RTC::InPortDirectConsumer::put ( ByteData & data )

overridevirtual

Send data to the destination port.

Pure virtual function to send data to the destination port.

This function might the following return codes

• PORT_OK: Normal return
• PORT_ERROR: Error occurred in data transfer process
• SEND_FULL: Buffer full although OutPort tried to send data
• SEND_TIMEOUT: Timeout although OutPort tried to send data
• UNKNOWN_ERROR: Unknown error

Implements RTC::InPortConsumer.

subscribeInterface()

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

overridevirtual

Subscribe to the data sending notification.

Subscribe to the data sending notification based on specified property information.

Parameters

properties

Information for subscription

Returns

Subscription result (Successful:true, Failed:false)

Implements RTC::InPortConsumer.

unsubscribeInterface()

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

overridevirtual

Unsubscribe the data send notification.

Unsubscribe the data send notification.

Parameters

properties

Information for unsubscription

Implements RTC::InPortConsumer.

---

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

• InPortDirectConsumer.h