RTC::OutPortSHMConsumer Class Reference

OutPortSHMConsumer class. More...

#include <OutPortSHMConsumer.h>

Inheritance diagram for RTC::OutPortSHMConsumer:

Collaboration diagram for RTC::OutPortSHMConsumer:

Public Member Functions
DATAPORTSTATUS_ENUM	OutPortSHMConsumer ()
	Constructor. More...
virtual	~OutPortSHMConsumer ()
	Destructor. More...
virtual void	init (coil::Properties &prop)
	Initializing configuration. More...
virtual void	setBuffer (CdrBufferBase *buffer)
	Setting outside buffer's pointer. More...
virtual void	setListener (ConnectorInfo &info, ConnectorListeners *listeners)
	Set the listener. More...
virtual ReturnCode	get (cdrMemoryStream &data)
	Read data. More...
virtual bool	subscribeInterface (const SDOPackage::NVList &properties)
	Subscribe the data receive notification. More...
virtual void	unsubscribeInterface (const SDOPackage::NVList &properties)
	Unsubscribe the data receive notification. More...
virtual bool	setObject (CORBA::Object_ptr obj)
	Set Object. More...
Public Member Functions inherited from RTC::OutPortConsumer
virtual DATAPORTSTATUS_ENUM	~OutPortConsumer (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 Attributes
coil::Mutex	m_mutex
Logger	rtclog
SharedMemoryPort	m_shmem
CdrBufferBase *	m_buffer
ConnectorListeners *	m_listeners
ConnectorInfo	m_profile
Protected Attributes inherited from RTC::OutPortConsumer
Logger	rtclog
	Logger stream. 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...

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...

Detailed Description

OutPortSHMConsumer class.

Since

0.4.0

Constructor & Destructor Documentation

DATAPORTSTATUS_ENUM RTC::OutPortSHMConsumer::OutPortSHMConsumer

(

)

Constructor.

Constructor

virtual RTC::OutPortSHMConsumer::~OutPortSHMConsumer ( )

virtual

Destructor.

Destructor

Member Function Documentation

virtual ReturnCode RTC::OutPortSHMConsumer::get ( cdrMemoryStream &  data )

virtual

Read data.

Read set data

Parameters

data	Object to receive the read data

Returns

Read result (Successful:true, Failed:false)

Implements RTC::OutPortConsumer.

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

virtual

Initializing configuration.

Parameters

prop	Configuration information

Implements RTC::OutPortConsumer.

virtual void RTC::OutPortSHMConsumer::setBuffer ( CdrBufferBase *  buffer )

virtual

Setting outside buffer's pointer.

Parameters

buffer

A pointer to a data buffer to be used by OutPortProvider

Implements RTC::OutPortConsumer.

virtual void RTC::OutPortSHMConsumer::setListener ( ConnectorInfo &  info, ConnectorListeners *  listeners  )

virtual

Set the listener.

Parameters

info	Connector information
listeners	Listener objects

Implements RTC::OutPortConsumer.

virtual bool RTC::OutPortSHMConsumer::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::OutPortSHMConsumer::subscribeInterface ( const SDOPackage::NVList &  properties )

virtual

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.

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

virtual

Unsubscribe the data receive notification.

Unsubscribe the data receive notification.

Parameters

properties

Unsubscription information

Implements RTC::OutPortConsumer.

Member Data Documentation

CdrBufferBase* RTC::OutPortSHMConsumer::m_buffer

protected

ConnectorListeners* RTC::OutPortSHMConsumer::m_listeners

protected

coil::Mutex RTC::OutPortSHMConsumer::m_mutex

protected

ConnectorInfo RTC::OutPortSHMConsumer::m_profile

protected

SharedMemoryPort RTC::OutPortSHMConsumer::m_shmem

protected

Logger RTC::OutPortSHMConsumer::rtclog

mutableprotected

---

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

• OutPortSHMConsumer.h