RTC::OutPortSHMProvider Class Reference

OutPortSHMProvider class. More...

#include <OutPortSHMProvider.h>

Inheritance diagram for RTC::OutPortSHMProvider:

Collaboration diagram for RTC::OutPortSHMProvider:

Public Member Functions
	OutPortSHMProvider ()
	Constructor.
	~OutPortSHMProvider () 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.
void	setConnector (OutPortConnector *connector) override
	set Connector
::OpenRTM::PortStatus	get () override
	[CORBA interface] Get data from the buffer
Public Member Functions inherited from RTC::OutPortProvider
virtual	~OutPortProvider ()
	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::OutPortProvider
void	setPortType (const char *port_type)
	Set the port type.
void	setDataType (const char *data_type)
	Set the data type.
void	setInterfaceType (const char *interface_type)
	Set the interface type.
void	setDataFlowType (const char *dataflow_type)
	Set the data flow type.
void	setSubscriptionType (const char *subs_type)
	Set the subscription type.
Protected Attributes inherited from RTC::OutPortProvider
SDOPackage::NVList	m_properties
	Properties to hold the port profiles .
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

OutPortSHMProvider class.

Since

1.2.0

Constructor & Destructor Documentation

OutPortSHMProvider()

RTC::OutPortSHMProvider::OutPortSHMProvider

(

)

Constructor.

Constructor

~OutPortSHMProvider()

RTC::OutPortSHMProvider::~OutPortSHMProvider ( )

override

Destructor.

Destructor

Member Function Documentation

get()

::OpenRTM::PortStatus RTC::OutPortSHMProvider::get ( )

override

[CORBA interface] Get data from the buffer

Get data from the internal buffer.

Returns

Data got from the buffer.

init()

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

overridevirtual

Initializing configuration.

Parameters

prop	Configuration information

Reimplemented from RTC::OutPortProvider.

setBuffer()

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

overridevirtual

Setting outside buffer's pointer.

Parameters

buffer

A pointer to a data buffer to be used by OutPortProvider

Implements RTC::OutPortProvider.

setConnector()

void RTC::OutPortSHMProvider::setConnector ( OutPortConnector * connector )

overridevirtual

set Connector

Parameters

connector

OutPortConnector

Implements RTC::OutPortProvider.

setListener()

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

overridevirtual

Set the listener.

Parameters

info	Connector information
listeners	Listener objects

Implements RTC::OutPortProvider.

---

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

• OutPortSHMProvider.h