OutPortSHMConsumer class.
More...
#include <OutPortSHMConsumer.h>
|
| enum | Enum {
PORT_OK = 0,
PORT_ERROR,
BUFFER_ERROR,
BUFFER_FULL,
BUFFER_EMPTY,
BUFFER_TIMEOUT,
SEND_FULL,
SEND_TIMEOUT,
RECV_EMPTY,
RECV_TIMEOUT,
INVALID_ARGS,
PRECONDITION_NOT_MET,
CONNECTION_LOST,
UNKNOWN_ERROR
} |
| | DataPortStatus return codes. More...
|
| |
| static const char * | toString (DataPortStatus::Enum status) |
| | Convert DataPortStatus into the string. More...
|
| |
OutPortSHMConsumer class.
- Since
- 0.4.0
◆ OutPortSHMConsumer()
◆ ~OutPortSHMConsumer()
| virtual RTC::OutPortSHMConsumer::~OutPortSHMConsumer |
( |
| ) |
|
|
virtual |
◆ get()
| virtual ReturnCode RTC::OutPortSHMConsumer::get |
( |
cdrMemoryStream & |
data | ) |
|
|
virtual |
Read data.
Read set data
- Parameters
-
| data | Object to receive the read data |
- Returns
- Read result (Successful:true, Failed:false)
Implements RTC::OutPortConsumer.
◆ init()
Initializing configuration.
- Parameters
-
| prop | Configuration information |
Implements RTC::OutPortConsumer.
◆ setBuffer()
| virtual void RTC::OutPortSHMConsumer::setBuffer |
( |
CdrBufferBase * |
buffer | ) |
|
|
virtual |
◆ setListener()
◆ setObject()
| virtual bool RTC::OutPortSHMConsumer::setObject |
( |
CORBA::Object_ptr |
obj | ) |
|
|
virtual |
Set Object.
Override function of ConsumerBase. This operation set an Object to CORBA:Object_var in the class, and this object is narrowed to given template parameter and stored in the member variable.
- Parameters
-
- Returns
- An object setting result. If target object is null, it returns false.
Reimplemented from RTC::CorbaConsumer< ::OpenRTM::PortSharedMemory >.
◆ subscribeInterface()
| virtual bool RTC::OutPortSHMConsumer::subscribeInterface |
( |
const SDOPackage::NVList & |
properties | ) |
|
|
virtual |
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()
| virtual void RTC::OutPortSHMConsumer::unsubscribeInterface |
( |
const SDOPackage::NVList & |
properties | ) |
|
|
virtual |
Unsubscribe the data receive notification.
Unsubscribe the data receive notification.
- Parameters
-
| properties | Unsubscription information |
Implements RTC::OutPortConsumer.
◆ m_buffer
◆ m_listeners
◆ m_mutex
◆ m_profile
◆ m_shmem
◆ rtclog
| Logger RTC::OutPortSHMConsumer::rtclog |
|
mutableprotected |
The documentation for this class was generated from the following file: