RTC::InPortCorbaConsumer< DataType > Class Template Reference

InPortCorbaConsumer class. More...

#include <InPortCorbaConsumer.h>

Inheritance diagram for RTC::InPortCorbaConsumer< DataType >:

RTC::InPortConsumer RTC::CorbaConsumer< RTC::InPortAny > RTC::CorbaConsumerBase

List of all members.

Public Member Functions

 InPortCorbaConsumer (BufferBase< DataType > &buffer)
 Constructor.
 InPortCorbaConsumer (const InPortCorbaConsumer< DataType > &consumer)
 Copy constructor.
InPortCorbaConsumeroperator= (const InPortCorbaConsumer< DataType > &consumer)
 Assignment operator.
virtual ~InPortCorbaConsumer ()
 Destructor.
void put (DataType &data)
 Write data into the buffer.
void push ()
 Read data from the buffer.
virtual
InPortCorbaConsumer
clone () const
 Generate clone.
virtual bool subscribeInterface (const SDOPackage::NVList &properties)
 Subscribe to the data sending notification.
virtual void unsubscribeInterface (const SDOPackage::NVList &properties)
 Unsubscribe the data send notification.


Detailed Description

template<class DataType>
class RTC::InPortCorbaConsumer< DataType >

InPortCorbaConsumer class.

This is an implementation class of the input port Consumer that uses CORBA for means of communication.

Parameters:
DataType Data type for this port
Since:
0.4.0

Constructor & Destructor Documentation

template<class DataType>
RTC::InPortCorbaConsumer< DataType >::InPortCorbaConsumer ( BufferBase< DataType > &  buffer  )  [inline]

Constructor.

Constructor

Parameters:
buffer The buffer object that is attached to this Consumer

template<class DataType>
RTC::InPortCorbaConsumer< DataType >::InPortCorbaConsumer ( const InPortCorbaConsumer< DataType > &  consumer  )  [inline]

Copy constructor.

Copy constructor

Parameters:
consumer InPortCorbaConsumer object of copy source

template<class DataType>
virtual RTC::InPortCorbaConsumer< DataType >::~InPortCorbaConsumer (  )  [inline, virtual]

Destructor.

Destructor


Member Function Documentation

template<class DataType>
InPortCorbaConsumer& RTC::InPortCorbaConsumer< DataType >::operator= ( const InPortCorbaConsumer< DataType > &  consumer  )  [inline]

Assignment operator.

Assignment operator

Parameters:
consumer InPortCorbaConsumer object of assignment source
Returns:
The assignment result

template<class DataType>
void RTC::InPortCorbaConsumer< DataType >::put ( DataType &  data  )  [inline]

Write data into the buffer.

Write data into the buffer.

Parameters:
data The target data for writing

template<class DataType>
void RTC::InPortCorbaConsumer< DataType >::push (  )  [inline, virtual]

Read data from the buffer.

Read data from the buffer and send it.

Implements RTC::InPortConsumer.

template<class DataType>
virtual InPortCorbaConsumer* RTC::InPortCorbaConsumer< DataType >::clone (  )  const [inline, virtual]

Generate clone.

Clone this InPortCorbaConsumer object.

Returns:
The clone InPortCorbaConsumer object

Implements RTC::InPortConsumer.

template<class DataType>
virtual bool RTC::InPortCorbaConsumer< DataType >::subscribeInterface ( const SDOPackage::NVList &  properties  )  [inline, virtual]

Subscribe to the data sending notification.

Subscribe to the data sending notification based on specified property information.

Parameters:
properties Information for subscription
Returns:
Subscription result (Successful:true, Failed:false)

Implements RTC::InPortConsumer.

template<class DataType>
virtual void RTC::InPortCorbaConsumer< DataType >::unsubscribeInterface ( const SDOPackage::NVList &  properties  )  [inline, virtual]

Unsubscribe the data send notification.

Unsubscribe the data send notification.

Parameters:
properties Information for unsubscription

Implements RTC::InPortConsumer.


Generated on Thu May 29 15:03:33 2008 for OpenRTM by  doxygen 1.5.3