Public Member Functions | Private Member Functions | Private Attributes
RTC::OutPortCorbaCdrConsumer Class Reference

OutPortCorbaCdrConsumer class. More...

#include <OutPortCorbaCdrConsumer.h>

Inheritance diagram for RTC::OutPortCorbaCdrConsumer:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ReturnCode get (cdrMemoryStream &data)
 Read data.
virtual void init (coil::Properties &prop)
 Initializing configuration.
DATAPORTSTATUS_ENUM OutPortCorbaCdrConsumer ()
 Constructor.
virtual void setBuffer (CdrBufferBase *buffer)
 Setting outside buffer's pointer.
virtual void setListener (ConnectorInfo &info, ConnectorListeners *listeners)
 Set the listener.
virtual bool subscribeInterface (const SDOPackage::NVList &properties)
 Subscribe the data receive notification.
virtual void unsubscribeInterface (const SDOPackage::NVList &properties)
 Unsubscribe the data receive notification.
virtual ~OutPortCorbaCdrConsumer (void)
 Destructor.

Private Member Functions

OutPortConsumer::ReturnCode convertReturn (::OpenRTM::PortStatus status, const cdrMemoryStream &data)
 Return codes conversion.
void onBufferFull (const cdrMemoryStream &data)
 Notify an ON_BUFFER_FULL event to listeners.
void onBufferWrite (const cdrMemoryStream &data)
 Notify an ON_BUFFER_WRITE event to listeners.
void onReceived (const cdrMemoryStream &data)
 Notify an ON_RECEIVED event to listeners.
void onReceiverFull (const cdrMemoryStream &data)
 Notify an ON_RECEIVER_FULL event to listeners.
void onSenderEmpty ()
 Notify an ON_SENDER_EMPTY event to listeners.
void onSenderError ()
void onSenderTimeout ()
 Notify an ON_SENDER_TIMEOUT event to listeners.

Private Attributes

CdrBufferBasem_buffer
ConnectorListenersm_listeners
ConnectorInfo m_profile

Detailed Description

OutPortCorbaCdrConsumer class.

The OutPort consumer class which uses the OpenRTM::OutPortCdr interface in CORBA for data transfer and realizes a pull-type dataflow.

Since:
0.4.0

Definition at line 55 of file OutPortCorbaCdrConsumer.h.


Constructor & Destructor Documentation

Constructor.

Constructor

Definition at line 33 of file OutPortCorbaCdrConsumer.cpp.

Destructor.

Destructor

Definition at line 45 of file OutPortCorbaCdrConsumer.cpp.


Member Function Documentation

OutPortConsumer::ReturnCode RTC::OutPortCorbaCdrConsumer::convertReturn ( ::OpenRTM::PortStatus  status,
const cdrMemoryStream &  data 
) [private]

Return codes conversion.

Definition at line 226 of file OutPortCorbaCdrConsumer.cpp.

OutPortConsumer::ReturnCode RTC::OutPortCorbaCdrConsumer::get ( cdrMemoryStream &  data) [virtual]

Read data.

Read set data

Parameters:
dataObject to receive the read data
Returns:
Read result (Successful:true, Failed:false)

Implements RTC::OutPortConsumer.

Definition at line 97 of file OutPortCorbaCdrConsumer.cpp.

Initializing configuration.

This operation would be called to configure in initialization. In the concrete class, configuration should be performed getting appropriate information from the given Properties data. This function might be called right after instantiation and connection sequence respectivly. Therefore, this function should be implemented assuming multiple call.

Parameters:
propConfiguration information

Implements RTC::OutPortConsumer.

Definition at line 56 of file OutPortCorbaCdrConsumer.cpp.

void RTC::OutPortCorbaCdrConsumer::onBufferFull ( const cdrMemoryStream &  data) [inline, private]

Notify an ON_BUFFER_FULL event to listeners.

Parameters:
datacdrMemoryStream

Definition at line 296 of file OutPortCorbaCdrConsumer.h.

void RTC::OutPortCorbaCdrConsumer::onBufferWrite ( const cdrMemoryStream &  data) [inline, private]

Notify an ON_BUFFER_WRITE event to listeners.

Parameters:
datacdrMemoryStream

Definition at line 281 of file OutPortCorbaCdrConsumer.h.

void RTC::OutPortCorbaCdrConsumer::onReceived ( const cdrMemoryStream &  data) [inline, private]

Notify an ON_RECEIVED event to listeners.

Parameters:
datacdrMemoryStream

Definition at line 311 of file OutPortCorbaCdrConsumer.h.

void RTC::OutPortCorbaCdrConsumer::onReceiverFull ( const cdrMemoryStream &  data) [inline, private]

Notify an ON_RECEIVER_FULL event to listeners.

Parameters:
datacdrMemoryStream

Definition at line 326 of file OutPortCorbaCdrConsumer.h.

void RTC::OutPortCorbaCdrConsumer::onSenderEmpty ( ) [inline, private]

Notify an ON_SENDER_EMPTY event to listeners.

Definition at line 339 of file OutPortCorbaCdrConsumer.h.

void RTC::OutPortCorbaCdrConsumer::onSenderError ( ) [inline, private]

Notify an ON_SENDER_ERROR event to listeners

Definition at line 365 of file OutPortCorbaCdrConsumer.h.

Notify an ON_SENDER_TIMEOUT event to listeners.

Definition at line 352 of file OutPortCorbaCdrConsumer.h.

Setting outside buffer's pointer.

A pointer to a buffer from which OutPortProvider retrieve data. If already buffer is set, previous buffer's pointer will be overwritten by the given pointer to a buffer. Since OutPortProvider does not assume ownership of the buffer pointer, destructor of the buffer should be done by user.

Parameters:
bufferA pointer to a data buffer to be used by OutPortProvider

Implements RTC::OutPortConsumer.

Definition at line 68 of file OutPortCorbaCdrConsumer.cpp.

void RTC::OutPortCorbaCdrConsumer::setListener ( ConnectorInfo info,
ConnectorListeners listeners 
) [virtual]

Set the listener.

OutPort provides callback functionality that calls specific listener objects according to the events in the data publishing process. For details, see documentation of ConnectorDataListener class and ConnectorListener class in ConnectorListener.h. In this OutPortCorbaCdrProvider provides the following callbacks.

  • ON_BUFFER_WRITE
  • ON_BUFFER_FULL
  • ON_RECEIVED
  • ON_RECEIVER_FULL
  • ON_SENDER_EMPTY
  • ON_SENDER_TIMEOUT
  • ON_SENDER_ERROR
Parameters:
infoConnector information
listenersListener objects

Implements RTC::OutPortConsumer.

Definition at line 81 of file OutPortCorbaCdrConsumer.cpp.

bool RTC::OutPortCorbaCdrConsumer::subscribeInterface ( const SDOPackage::NVList &  properties) [virtual]

Subscribe the data receive notification.

Subscribe the data receive notification based on specified property information

Parameters:
propertiesSubscription information
Returns:
Subscription result (Successful:true, Failed:false)

Implements RTC::OutPortConsumer.

Definition at line 146 of file OutPortCorbaCdrConsumer.cpp.

void RTC::OutPortCorbaCdrConsumer::unsubscribeInterface ( const SDOPackage::NVList &  properties) [virtual]

Unsubscribe the data receive notification.

Unsubscribe the data receive notification.

Parameters:
propertiesUnsubscription information

Implements RTC::OutPortConsumer.

Definition at line 190 of file OutPortCorbaCdrConsumer.cpp.


Member Data Documentation

Definition at line 372 of file OutPortCorbaCdrConsumer.h.

Definition at line 373 of file OutPortCorbaCdrConsumer.h.

Definition at line 374 of file OutPortCorbaCdrConsumer.h.


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


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Thu Aug 27 2015 14:16:41