#include <OutPortSHMConsumer.h>

Inheritance diagram for RTC::OutPortSHMConsumer:

[legend]

Collaboration diagram for RTC::OutPortSHMConsumer:

[legend]

Public Member Functions
	OutPortSHMConsumer ()
	Constructor. More...

	~OutPortSHMConsumer () override
	Destructor. More...

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

void	setBuffer (CdrBufferBase *buffer) override
	Setting outside buffer's pointer. More...

void	setListener (ConnectorInfo &info, ConnectorListenersBase *listeners) override
	Set the listener. More...

DataPortStatus	get (ByteData &data) override
	Read data. More...

bool	subscribeInterface (const SDOPackage::NVList &properties) override
	Subscribe the data receive notification. More...

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

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

Public Member Functions inherited from RTC::OutPortConsumer
virtual	~OutPortConsumer ()=default
	Destructor. More...

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

virtual void	setBuffer (CdrBufferBase *buffer)=0
	Setting outside buffer's pointer. More...

virtual void	setListener (ConnectorInfo &info, ConnectorListenersBase *listeners)=0
	Set the listener. More...

virtual DataPortStatus	get (ByteData &data)=0
	Receive data. More...

virtual bool	subscribeInterface (const SDOPackage::NVList &properties)=0
	Subscribe the data receive notification. More...

virtual void	unsubscribeInterface (const SDOPackage::NVList &properties)=0
	Unsubscribe the data receive notification. 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)

	~CorbaConsumer () override
	Virtual destructor. More...

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

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

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

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

Public Member Functions inherited from RTC::CorbaConsumerBase
	CorbaConsumerBase ()=default
	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 ()
	Virtual destructor. More...

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

virtual CORBA::Object_ptr	getObject ()
	Get CORBA Object. More...

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

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

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

The given CORBA Object is held as CORBA::Object_var type in ConsumerBase object.

Parameters

obj	Object reference of CORBA object

Returns: If obj is nil reference, it returns false.

Reimplemented from RTC::CorbaConsumerBase.

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

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OutPortSHMConsumer()

◆ ~OutPortSHMConsumer()

Member Function Documentation

◆ get()

◆ init()

◆ setBuffer()

◆ setListener()

◆ setObject()

◆ subscribeInterface()

◆ unsubscribeInterface()

Member Data Documentation

◆ m_buffer

◆ m_endian

◆ m_listeners

◆ m_memory_size

◆ m_mutex

◆ m_profile

◆ m_properties

◆ m_shm_address

◆ m_shmem

◆ rtclog