RTC::OutPortSHMConsumer Class Reference

OutPortSHMConsumer class. More...

#include <OutPortSHMConsumer.h>

Inheritance diagram for RTC::OutPortSHMConsumer:

Collaboration diagram for RTC::OutPortSHMConsumer:

Public Member Functions
	OutPortSHMConsumer ()
	Constructor.
	~OutPortSHMConsumer () 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.
bool	setObject (CORBA::Object_ptr obj) override
	Set Object.
Public Member Functions inherited from RTC::OutPortConsumer
virtual	~OutPortConsumer ()=default
	Destructor.
Public Member Functions inherited from RTC::CorbaConsumer< ::OpenRTM::PortSharedMemory >
	CorbaConsumer ()
	Consructor.
	CorbaConsumer (const CorbaConsumer &x)
	Copy constructor.
CorbaConsumer &	operator= (const CorbaConsumer &x)
	Assignment operator.
void	swap (CorbaConsumer &x)
	~CorbaConsumer () override
	Virtual destructor.
typename ::OpenRTM::PortSharedMemory::_ptr_type	_ptr ()
	Get Object reference narrowed as ObjectType.
typename ::OpenRTM::PortSharedMemory::_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.

Protected Attributes
Logger	rtclog
coil::Properties	m_properties
std::mutex	m_mutex
std::string	m_shm_address
SharedMemoryPort	m_shmem
int	m_memory_size
bool	m_endian
CdrBufferBase *	m_buffer
ConnectorListenersBase *	m_listeners {nullptr}
ConnectorInfo	m_profile
Protected Attributes inherited from RTC::OutPortConsumer
Logger	rtclog
	Logger stream .
Protected Attributes inherited from RTC::CorbaConsumer< ::OpenRTM::PortSharedMemory >
typename ::OpenRTM::PortSharedMemory::_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

OutPortSHMConsumer class.

Since

0.4.0

Constructor & Destructor Documentation

OutPortSHMConsumer()

RTC::OutPortSHMConsumer::OutPortSHMConsumer

(

)

Constructor.

Constructor

~OutPortSHMConsumer()

RTC::OutPortSHMConsumer::~OutPortSHMConsumer ( )

override

Destructor.

Destructor

Member Function Documentation

get()

DataPortStatus RTC::OutPortSHMConsumer::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::OutPortSHMConsumer::init ( coil::Properties & prop )

overridevirtual

Initializing configuration.

Parameters

prop	Configuration information

Implements RTC::OutPortConsumer.

setBuffer()

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

overridevirtual

Setting outside buffer's pointer.

Parameters

buffer

A pointer to a data buffer to be used by OutPortProvider

Implements RTC::OutPortConsumer.

setListener()

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

overridevirtual

Set the listener.

Parameters

info	Connector information
listeners	Listener objects

Implements RTC::OutPortConsumer.

setObject()

bool RTC::OutPortSHMConsumer::setObject ( CORBA::Object_ptr obj )

overridevirtual

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

subscribeInterface()

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

overridevirtual

Unsubscribe the data receive notification.

Unsubscribe the data receive notification.

Parameters

properties

Unsubscription information

Implements RTC::OutPortConsumer.

Member Data Documentation

m_buffer

CdrBufferBase* RTC::OutPortSHMConsumer::m_buffer

protected

m_endian

bool RTC::OutPortSHMConsumer::m_endian

protected

m_listeners

ConnectorListenersBase* RTC::OutPortSHMConsumer::m_listeners {nullptr}

protected

m_memory_size

int RTC::OutPortSHMConsumer::m_memory_size

protected

m_mutex

std::mutex RTC::OutPortSHMConsumer::m_mutex

protected

m_profile

ConnectorInfo RTC::OutPortSHMConsumer::m_profile

protected

m_properties

coil::Properties RTC::OutPortSHMConsumer::m_properties

protected

m_shm_address

std::string RTC::OutPortSHMConsumer::m_shm_address

protected

m_shmem

SharedMemoryPort RTC::OutPortSHMConsumer::m_shmem

protected

rtclog

Logger RTC::OutPortSHMConsumer::rtclog

mutableprotected

---

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

• OutPortSHMConsumer.h