#include <InPortSHMConsumer.h>

Inheritance diagram for RTC::InPortSHMConsumer:

[legend]

Collaboration diagram for RTC::InPortSHMConsumer:

[legend]

Public Member Functions
DATAPORTSTATUS_ENUM	InPortSHMConsumer ()
	Constructor. More...

virtual	~InPortSHMConsumer ()
	Destructor. More...

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

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

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

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

virtual bool	subscribeInterface (const SDOPackage::NVList &properties)
	Subscribe the data send 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::PortSharedMemory >
	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...

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

typename::OpenRTM::PortSharedMemory::_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...

Protected Member Functions
InPortConsumer::ReturnCode	convertReturnCode (OpenRTM::PortStatus ret)

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::PortSharedMemory >
typename::OpenRTM::PortSharedMemory::_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

InPortSHMConsumer class.

Since: 1.2.0

Constructor & Destructor Documentation

DATAPORTSTATUS_ENUM RTC::InPortSHMConsumer::InPortSHMConsumer ( )

Constructor.

Constructor

Parameters

buffer The buffer object that is attached to this Consumer

virtual RTC::InPortSHMConsumer::~InPortSHMConsumer ( )

virtual

Destructor.

Destructor

Member Function Documentation

InPortConsumer::ReturnCode RTC::InPortSHMConsumer::convertReturnCode ( OpenRTM::PortStatus ret )

protected

virtual void RTC::InPortSHMConsumer::init ( coil::Properties & prop )

virtual

Initializing configuration.

Parameters

prop	Configuration information

Implements RTC::InPortConsumer.

virtual void RTC::InPortSHMConsumer::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 InPortConsumer::ReturnCode RTC::InPortSHMConsumer::put ( cdrMemoryStream & data )

virtual

Send data to the destination port.

Implements RTC::InPortConsumer.

virtual bool RTC::InPortSHMConsumer::setObject ( CORBA::Object_ptr obj )

virtual

Set Object.

Override function of ConsumerBase. This operation set an Object to CORBA:Object_var in the class, and this object is narrowed to given template parameter and stored in the member variable.

Parameters

obj	CORBA Objecct

Returns: An object setting result. If target object is null, it returns false.

Reimplemented from RTC::CorbaConsumer< ::OpenRTM::PortSharedMemory >.

virtual bool RTC::InPortSHMConsumer::subscribeInterface ( const SDOPackage::NVList & properties )

virtual

Subscribe the data send notification.

Pure virtual function to subscribe the data send notification based on specified property information.

Parameters

properties Properties for reference when subscribing

Returns: Subscription result

Implements RTC::InPortConsumer.

virtual void RTC::InPortSHMConsumer::unsubscribeInterface ( const SDOPackage::NVList & properties )

virtual

Unsubscribe the data send notification.

Pure virtual function to unsubscribe the data send notification.

Parameters

properties Properties for reference when unsubscribing

Implements RTC::InPortConsumer.

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

InPortSHMConsumer.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation