OpenRTM-aist  1.2.1
Public Member Functions | List of all members
RTC::OutPortCorbaCdrProvider Class Reference

OutPortCorbaCdrProvider class. More...

#include <OutPortCorbaCdrProvider.h>

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

Public Member Functions

 OutPortCorbaCdrProvider (void)
 Constructor. More...
 
virtual ~OutPortCorbaCdrProvider (void)
 Destructor. More...
 
virtual void init (coil::Properties &prop)
 Initializing configuration. More...
 
virtual void setBuffer (CdrBufferBase *buffer)
 Setting outside buffer's pointer. More...
 
virtual void setListener (ConnectorInfo &info, ConnectorListeners *listeners)
 Set the listener. More...
 
virtual void setConnector (OutPortConnector *connector)
 set Connector More...
 
virtual ::OpenRTM::PortStatus get (::OpenRTM::CdrData_out data) throw (CORBA::SystemException)
 [CORBA interface] Get data from the buffer More...
 
- Public Member Functions inherited from RTC::OutPortProvider
virtual DATAPORTSTATUS_ENUM ~OutPortProvider (void)
 Destructor. More...
 
virtual void publishInterfaceProfile (SDOPackage::NVList &properties)
 Publish InterfaceProfile information. More...
 
virtual bool publishInterface (SDOPackage::NVList &properties)
 Publish interface information. More...
 

Additional Inherited Members

- Public Types inherited from RTC::DataPortStatus
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 Public Member Functions inherited from RTC::DataPortStatus
static const char * toString (DataPortStatus::Enum status)
 Convert DataPortStatus into the string. More...
 
- Protected Member Functions inherited from RTC::OutPortProvider
void setPortType (const char *port_type)
 Set the port type. More...
 
void setDataType (const char *data_type)
 Set the data type. More...
 
void setInterfaceType (const char *interface_type)
 Set the interface type. More...
 
void setDataFlowType (const char *dataflow_type)
 Set the data flow type. More...
 
void setSubscriptionType (const char *subs_type)
 Set the subscription type. More...
 
- Protected Attributes inherited from RTC::OutPortProvider
SDOPackage::NVList m_properties
 Properties to hold the port profiles. More...
 
Logger rtclog
 Logger stream. More...
 

Detailed Description

OutPortCorbaCdrProvider class.

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

Since
0.4.0

Constructor & Destructor Documentation

RTC::OutPortCorbaCdrProvider::OutPortCorbaCdrProvider ( void  )

Constructor.

Constructor

virtual RTC::OutPortCorbaCdrProvider::~OutPortCorbaCdrProvider ( void  )
virtual

Destructor.

Destructor

Member Function Documentation

virtual ::OpenRTM::PortStatus RTC::OutPortCorbaCdrProvider::get ( ::OpenRTM::CdrData_out  data)
throw (CORBA::SystemException
)

[CORBA interface] Get data from the buffer

Get data from the internal buffer.

Returns
Data got from the buffer.
virtual void RTC::OutPortCorbaCdrProvider::init ( coil::Properties prop)
virtual

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

Reimplemented from RTC::OutPortProvider.

virtual void RTC::OutPortCorbaCdrProvider::setBuffer ( CdrBufferBase buffer)
virtual

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::OutPortProvider.

virtual void RTC::OutPortCorbaCdrProvider::setConnector ( OutPortConnector connector)
virtual

set Connector

OutPort creates OutPortConnector object when it establishes connection between OutPort and InPort, and it calls this function with a pointer to the connector object. Since the OutPort has the ownership of this connector, OutPortProvider should not delete it.

Parameters
connectorOutPortConnector

Implements RTC::OutPortProvider.

virtual void RTC::OutPortCorbaCdrProvider::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_READ
  • ON_SEND
  • ON_BUFFER_EMPTY
  • ON_BUFFER_READ_TIMEOUT
  • ON_SENDER_EMPTY
  • ON_SENDER_TIMEOUT
  • ON_SENDER_ERROR
Parameters
infoConnector information
listenersListener objects

Implements RTC::OutPortProvider.


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