#include <InPortCorbaCdrConsumer.h>

Inheritance diagram for RTC::InPortCorbaCdrConsumer:

[legend]

Collaboration diagram for RTC::InPortCorbaCdrConsumer:

[legend]

Public Member Functions
DATAPORTSTATUS_ENUM	InPortCorbaCdrConsumer (void)
	Constructor. More...

virtual	~InPortCorbaCdrConsumer (void)
	Destructor. More...

virtual void	init (coil::Properties &prop)
	Initializing configuration. More...

virtual ReturnCode	put (cdrMemoryStream &data)
	Send data to the destination port. More...

virtual void	publishInterfaceProfile (SDOPackage::NVList &properties)
	Publish InterfaceProfile information. More...

virtual bool	subscribeInterface (const SDOPackage::NVList &properties)
	Subscribe to the data sending notification. More...

virtual void	unsubscribeInterface (const SDOPackage::NVList &properties)
	Unsubscribe the data send notification. More...

Public Member Functions inherited from RTC::InPortConsumer
virtual DATAPORTSTATUS_ENUM	~InPortConsumer (void)
	Destructor. More...

Public Member Functions inherited from RTC::CorbaConsumer< ::OpenRTM::InPortCdr >
	CorbaConsumer ()
	Consructor. More...

	CorbaConsumer (const CorbaConsumer &x)
	Copy constructor. More...

CorbaConsumer &	operator= (const CorbaConsumer &x)
	Assignment operator. More...

void	swap (CorbaConsumer &x)

virtual	~CorbaConsumer (void)
	Virtual destructor. More...

virtual bool	setObject (CORBA::Object_ptr obj)
	Set Object. More...

typename::OpenRTM::InPortCdr::_ptr_type	_ptr ()
	Get Object reference narrowed as ObjectType. More...

typename::OpenRTM::InPortCdr::_ptr_type	operator-> ()
	Get Object reference narrowed as ObjectType. More...

virtual void	releaseObject ()
	Clear CORBA object setting. More...

Public Member Functions inherited from RTC::CorbaConsumerBase
	CorbaConsumerBase ()
	Consructor. More...

	CorbaConsumerBase (const CorbaConsumerBase &x)
	Copy Consructor. More...

CorbaConsumerBase &	operator= (const CorbaConsumerBase &x)
	Assignment operator. More...

void	swap (CorbaConsumerBase &x)
	swap function More...

virtual	~CorbaConsumerBase (void)
	Virtual destructor. More...

virtual CORBA::Object_ptr	getObject ()
	Get CORBA Object. 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 Attributes inherited from RTC::CorbaConsumer< ::OpenRTM::InPortCdr >
typename::OpenRTM::InPortCdr::_var_type	m_var
	CORBA object which has been set. More...

Protected Attributes inherited from RTC::CorbaConsumerBase
CORBA::Object_var	m_objref
	CORBA object which is set. More...

Detailed Description

InPortCorbaCdrConsumer 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

DATAPORTSTATUS_ENUM RTC::InPortCorbaCdrConsumer::InPortCorbaCdrConsumer ( void )

Constructor.

Constructor

Parameters

buffer The buffer object that is attached to this Consumer

virtual RTC::InPortCorbaCdrConsumer::~InPortCorbaCdrConsumer ( void )

virtual

Destructor.

Destructor

Member Function Documentation

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

virtual void RTC::InPortCorbaCdrConsumer::publishInterfaceProfile ( SDOPackage::NVList & properties )

virtual

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.

virtual ReturnCode RTC::InPortCorbaCdrConsumer::put ( cdrMemoryStream & data )

virtual

Send data to the destination port.

Pure virtual function to send data to the destination port.

This function might the following return codes