RTC::InPortSHMProvider Class Reference

InPortSHMProvider class. More...

#include <InPortSHMProvider.h>

Inheritance diagram for RTC::InPortSHMProvider:

Collaboration diagram for RTC::InPortSHMProvider:

Public Member Functions
	InPortSHMProvider ()
	Constructor.
	~InPortSHMProvider () override
	Destructor.
void	init (coil::Properties &prop) override
	Initializing configuration.
void	setBuffer (BufferBase< ByteData > *buffer) override
	Setting outside buffer's pointer.
void	setListener (ConnectorInfo &info, ConnectorListenersBase *listeners) override
	Set the listener.
void	setConnector (InPortConnector *connector) override
	set Connector
::OpenRTM::PortStatus	put () override
	[CORBA interface] Write data into the buffer
Public Member Functions inherited from RTC::InPortProvider
	InPortProvider ()
	Constructor.
virtual	~InPortProvider ()
	Destructor.
virtual void	publishInterfaceProfile (SDOPackage::NVList &prop)
	Publish InterfaceProfile information.
virtual bool	publishInterface (SDOPackage::NVList &prop)
	Publish interface information.
Public Member Functions inherited from RTC::SharedMemoryPort
	SharedMemoryPort ()
	Constructor.
	~SharedMemoryPort () override
	Destructor.
virtual int	string_to_MemorySize (std::string size_str)
void	create_memory (::CORBA::ULongLong memory_size, const char *shm_address) override
void	open_memory (::CORBA::ULongLong memory_size, const char *shm_address) override
void	close_memory (::CORBA::Boolean unlink=false) override
virtual void	write (ByteData &data)
virtual void	read (ByteData &data)
void	setInterface (::OpenRTM::PortSharedMemory_ptr sm) override
void	setEndian (::CORBA::Boolean endian) override
::OpenRTM::PortStatus	put () override
::OpenRTM::PortStatus	get () override
virtual::OpenRTM::PortSharedMemory_ptr	getObjRef ()

Additional Inherited Members
Protected Member Functions inherited from RTC::InPortProvider
void	setInterfaceType (const char *interface_type)
	Set the interface type.
void	setDataFlowType (const char *dataflow_type)
	Set the dataflow type.
void	setSubscriptionType (const char *subs_type)
	Set the subscription type.
Protected Attributes inherited from RTC::InPortProvider
SDOPackage::NVList	m_properties
	Properties to hold port profile .
Logger	rtclog
	Logger stream .
Protected Attributes inherited from RTC::SharedMemoryPort
::OpenRTM::PortSharedMemory_var	m_smInterface {OpenRTM::PortSharedMemory::_nil()}
bool	m_endian {true}
coil::SharedMemory	m_shmem

Detailed Description

InPortSHMProvider class.

Since

1.2.0

Constructor & Destructor Documentation

InPortSHMProvider()

RTC::InPortSHMProvider::InPortSHMProvider

(

)

Constructor.

Constructor

~InPortSHMProvider()

RTC::InPortSHMProvider::~InPortSHMProvider ( )

override

Destructor.

Destructor

Member Function Documentation

init()

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

overridevirtual

Initializing configuration.

Implements RTC::InPortProvider.

put()

::OpenRTM::PortStatus RTC::InPortSHMProvider::put ( )

override

[CORBA interface] Write data into the buffer

Write data into the specified buffer.

Parameters

data	The target data for writing

setBuffer()

void RTC::InPortSHMProvider::setBuffer ( BufferBase< ByteData > * buffer )

overridevirtual

Setting outside buffer's pointer.

Implements RTC::InPortProvider.

setConnector()

void RTC::InPortSHMProvider::setConnector ( InPortConnector * connector )

overridevirtual

set Connector

Parameters

connector

OutPortConnector

Implements RTC::InPortProvider.

setListener()

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

overridevirtual

Set the listener.

Parameters

info	Connector information
listeners	Listener objects

Implements RTC::InPortProvider.

---

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

• InPortSHMProvider.h