OpenRTM-aist 2.1.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
RTC::OutPortSHMConsumer Class Reference

OutPortSHMConsumer class. More...

#include <OutPortSHMConsumer.h>

Inheritance diagram for RTC::OutPortSHMConsumer:
Inheritance graph
[legend]
Collaboration diagram for RTC::OutPortSHMConsumer:
Collaboration graph
[legend]

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.
 
CorbaConsumeroperator= (const CorbaConsumer &x)
 Assignment operator.
 
void swap (CorbaConsumer &x)
 
 ~CorbaConsumer () override
 Virtual destructor.
 
typename ObjectType::_ptr_type _ptr ()
 Get Object reference narrowed as ObjectType.
 
typename ObjectType::_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.
 
CorbaConsumerBaseoperator= (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
 
CdrBufferBasem_buffer
 
ConnectorListenersBasem_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. .
 
- 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.

◆ ~OutPortSHMConsumer()

RTC::OutPortSHMConsumer::~OutPortSHMConsumer ( )
override

Destructor.

Member Function Documentation

◆ get()

DataPortStatus RTC::OutPortSHMConsumer::get ( ByteData data)
overridevirtual

Read data.

Implements RTC::OutPortConsumer.

◆ init()

void RTC::OutPortSHMConsumer::init ( coil::Properties &  prop)
overridevirtual

Initializing configuration.

Parameters
propConfiguration information

Implements RTC::OutPortConsumer.

◆ setBuffer()

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

Setting outside buffer's pointer.

Implements RTC::OutPortConsumer.

◆ setListener()

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

Set the listener.

Implements RTC::OutPortConsumer.

◆ setObject()

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

Set Object.

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

◆ subscribeInterface()

bool RTC::OutPortSHMConsumer::subscribeInterface ( const SDOPackage::NVList &  properties)
overridevirtual

Subscribe the data receive notification.

Implements RTC::OutPortConsumer.

◆ unsubscribeInterface()

void RTC::OutPortSHMConsumer::unsubscribeInterface ( const SDOPackage::NVList &  properties)
overridevirtual

Unsubscribe the data receive notification.

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: