RTC::InPortSHMConsumer Class Reference

InPortSHMConsumer class. More...

#include <InPortSHMConsumer.h>

Inheritance diagram for RTC::InPortSHMConsumer:

Collaboration diagram for RTC::InPortSHMConsumer:

Public Member Functions
	InPortSHMConsumer ()
	Constructor.
	~InPortSHMConsumer () override
	Destructor.
void	init (coil::Properties &prop) override
	Initializing configuration.
DataPortStatus	put (ByteData &data) override
	Send data to the destination port.
bool	setObject (CORBA::Object_ptr obj) override
void	publishInterfaceProfile (SDOPackage::NVList &properties) override
	Publish InterfaceProfile information.
bool	subscribeInterface (const SDOPackage::NVList &properties) override
	Subscribe the data send notification.
void	unsubscribeInterface (const SDOPackage::NVList &properties) override
	Unsubscribe the data send notification.
Public Member Functions inherited from RTC::InPortConsumer
virtual	~InPortConsumer ()=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.

Static Protected Member Functions
static DataPortStatus	convertReturnCode (OpenRTM::PortStatus ret)

Protected Attributes
coil::Properties	m_properties
std::mutex	m_mutex
std::string	m_shm_address
SharedMemoryPort	m_shmem
int	m_memory_size {0}
bool	m_endian {true}
Logger	rtclog {"InPortSHMConsumer"}
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

InPortSHMConsumer class.

Since

1.2.0

Constructor & Destructor Documentation

InPortSHMConsumer()

RTC::InPortSHMConsumer::InPortSHMConsumer

(

)

Constructor.

Constructor

Parameters

buffer

The buffer object that is attached to this Consumer

~InPortSHMConsumer()

RTC::InPortSHMConsumer::~InPortSHMConsumer ( )

override

Destructor.

Destructor

Member Function Documentation

convertReturnCode()

static DataPortStatus RTC::InPortSHMConsumer::convertReturnCode ( OpenRTM::PortStatus ret )

staticprotected

init()

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

overridevirtual

Initializing configuration.

Parameters

prop	Configuration information

Implements RTC::InPortConsumer.

publishInterfaceProfile()

void RTC::InPortSHMConsumer::publishInterfaceProfile ( SDOPackage::NVList & properties )

overridevirtual

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.

put()

DataPortStatus RTC::InPortSHMConsumer::put ( ByteData & data )

overridevirtual

Send data to the destination port.

Implements RTC::InPortConsumer.

setObject()

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

overridevirtual

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

subscribeInterface()

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

overridevirtual

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.

unsubscribeInterface()

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

overridevirtual

Unsubscribe the data send notification.

Pure virtual function to unsubscribe the data send notification.

Parameters

properties

Properties for reference when unsubscribing

Implements RTC::InPortConsumer.

Member Data Documentation

m_endian

bool RTC::InPortSHMConsumer::m_endian {true}

protected

m_memory_size

int RTC::InPortSHMConsumer::m_memory_size {0}

protected

m_mutex

std::mutex RTC::InPortSHMConsumer::m_mutex

protected

m_properties

coil::Properties RTC::InPortSHMConsumer::m_properties

protected

m_shm_address

std::string RTC::InPortSHMConsumer::m_shm_address

protected

m_shmem

SharedMemoryPort RTC::InPortSHMConsumer::m_shmem

protected

rtclog

Logger RTC::InPortSHMConsumer::rtclog {"InPortSHMConsumer"}

mutableprotected

---

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

• InPortSHMConsumer.h