RTC::InPortConsumer Class Reference

InPortConsumer abstract class. More...

#include <InPortConsumer.h>

Inheritance diagram for RTC::InPortConsumer:

RTC::InPortCorbaConsumer< DataType > RTC::InPortTcpSockConsumer< DataType >

List of all members.

Public Member Functions

virtual ~InPortConsumer ()
 Constructor.
virtual void push ()=0
 Send data to the destination port.
virtual InPortConsumerclone () const =0
 Clone this port.
virtual bool subscribeInterface (const SDOPackage::NVList &properties)=0
 Subscribe the data send notification.
virtual void unsubscribeInterface (const SDOPackage::NVList &properties)=0
 Unsubscribe the data send notification.


Detailed Description

InPortConsumer abstract class.

This is the abstract interface class for the input port Consumer. Concrete classes must implement the following pure virtual functions.

Since:
0.4.0

Constructor & Destructor Documentation

virtual RTC::InPortConsumer::~InPortConsumer (  )  [inline, virtual]

Constructor.

Constructor

Destructor

Destructor


Member Function Documentation

virtual void RTC::InPortConsumer::push (  )  [pure virtual]

Send data to the destination port.

Pure virtual function to send data to the destination port.

Implemented in RTC::InPortCorbaConsumer< DataType >, and RTC::InPortTcpSockConsumer< DataType >.

virtual InPortConsumer* RTC::InPortConsumer::clone (  )  const [pure virtual]

Clone this port.

Pure virtual function to generate this clone port.

Returns:
The clone InPortConsumer object

Implemented in RTC::InPortCorbaConsumer< DataType >, and RTC::InPortTcpSockConsumer< DataType >.

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

Subscribe the data send notification.

Pure virtual function to subscribe the data send notification based on specified property information.

Parameters:
properties Properties for reference when subscribing
Returns:
Subscription result

Implemented in RTC::InPortCorbaConsumer< DataType >, and RTC::InPortTcpSockConsumer< DataType >.

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

Unsubscribe the data send notification.

Pure virtual function to unsubscribe the data send notification.

Parameters:
properties Properties for reference when unsubscribing

Implemented in RTC::InPortCorbaConsumer< DataType >, and RTC::InPortTcpSockConsumer< DataType >.


Generated on Wed May 21 05:17:34 2008 for OpenRTM by  doxygen 1.5.3