RTC::OutPortPullConnector Class Reference

OutPortPullConnector base class. More...

#include <OutPortPullConnector.h>

Inheritance diagram for RTC::OutPortPullConnector:

RTC::OutPortConnector RTC::ConnectorBase RTC::DataPortStatus

List of all members.

Public Member Functions

DATAPORTSTATUS_ENUM OutPortPullConnector (ConnectorInfo info, OutPortProvider *provider, ConnectorListeners &listeners, CdrBufferBase *buffer=0)
virtual ~OutPortPullConnector ()
 Destructor.
virtual ReturnCode write (const cdrMemoryStream &data)
 Writing data.
virtual ReturnCode disconnect ()
 disconnect
virtual CdrBufferBasegetBuffer ()
 Getting Buffer.
virtual void activate ()
 Connector activation.
virtual void deactivate ()
 Connector deactivation.
CdrBufferBasecreateBuffer (ConnectorInfo &info)
 create buffer
void onConnect ()
 Invoke callback when connection is established.
void onDisconnect ()
 Invoke callback when connection is destroied.

Protected Attributes

OutPortProviderm_provider
 the pointer to the OutPortProvider
ConnectorListenersm_listeners
 A reference to a ConnectorListener.
CdrBufferBasem_buffer
 the pointer to the buffer


Detailed Description

OutPortPullConnector base class.

A connector class for pull type dataflow of OutPort

Since:
1.0.0

Constructor & Destructor Documentation

DATAPORTSTATUS_ENUM RTC::OutPortPullConnector::OutPortPullConnector ( ConnectorInfo  info,
OutPortProvider provider,
ConnectorListeners listeners,
CdrBufferBase buffer = 0 
)

virtual RTC::OutPortPullConnector::~OutPortPullConnector (  )  [virtual]

Destructor.

This operation calls disconnect(), which destructs and deletes the consumer, the publisher and the buffer.


Member Function Documentation

virtual ReturnCode RTC::OutPortPullConnector::write ( const cdrMemoryStream &  data  )  [virtual]

Writing data.

This operation writes data into publisher and then the data will be transferred to correspondent InPort.

Implements RTC::OutPortConnector.

virtual ReturnCode RTC::OutPortPullConnector::disconnect (  )  [virtual]

disconnect

This operation destruct and delete the consumer, the publisher and the buffer.

Implements RTC::OutPortConnector.

virtual CdrBufferBase* RTC::OutPortPullConnector::getBuffer (  )  [virtual]

Getting Buffer.

This operation returns this connector's buffer

Implements RTC::OutPortConnector.

virtual void RTC::OutPortPullConnector::activate (  )  [inline, virtual]

Connector activation.

This operation activates this connector

Implements RTC::ConnectorBase.

virtual void RTC::OutPortPullConnector::deactivate (  )  [inline, virtual]

Connector deactivation.

This operation deactivates this connector

Implements RTC::ConnectorBase.

CdrBufferBase* RTC::OutPortPullConnector::createBuffer ( ConnectorInfo info  ) 

create buffer

void RTC::OutPortPullConnector::onConnect (  ) 

Invoke callback when connection is established.

void RTC::OutPortPullConnector::onDisconnect (  ) 

Invoke callback when connection is destroied.


Member Data Documentation

the pointer to the OutPortProvider

A reference to a ConnectorListener.

the pointer to the buffer


Generated on Thu Jan 28 13:25:36 2010 for OpenRTM by  doxygen 1.5.5