RTC::DataOutPort Class Reference

OutPort abstruct class. More...

#include <DataOutPort.h>

Inheritance diagram for RTC::DataOutPort:

RTC::PortBase

List of all members.

Public Member Functions

template<class DataType, template< class DataType > class Buffer>
 DataOutPort (const char *name, OutPort< DataType, Buffer > &outport, Properties &prop)
 Constructor.
virtual ~DataOutPort ()
 Destructor.

Protected Member Functions

virtual ReturnCode_t publishInterfaces (ConnectorProfile &connector_profile)
 Publish interface information.
virtual ReturnCode_t subscribeInterfaces (const ConnectorProfile &connector_profile)
 Subscribe to the interface.
virtual void unsubscribeInterfaces (const ConnectorProfile &connector_profile)
 Disconnect the interface connection.

Classes

struct  publish
 Functor to publish the interface. More...
struct  subscribe
struct  unsubscribe
 Functor to unsubscribe the interface. More...


Detailed Description

OutPort abstruct class.

Constructor & Destructor Documentation

template<class DataType, template< class DataType > class Buffer>
RTC::DataOutPort::DataOutPort ( const char *  name,
OutPort< DataType, Buffer > &  outport,
Properties prop 
) [inline]

Constructor.

Constructor

Parameters:
name Port name
outport OutPort object associated with this data output port. Specify also the data type and the buffer type used in the OutPort object.
prop Property for setting ports

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

Destructor.

Destructor


Member Function Documentation

virtual ReturnCode_t RTC::DataOutPort::publishInterfaces ( ConnectorProfile &  connector_profile  )  [protected, virtual]

Publish interface information.

This operation is pure virutal function that would be called at the beginning of the notify_connect() process sequence. In the notify_connect(), the following methods would be called in order.

This operation should create the new connection for the new connector_id, and should update the connection for the existing connection_id.

Parameters:
connector_profile The connection profile information
Returns:
The return code of ReturnCode_t type.

Implements RTC::PortBase.

virtual ReturnCode_t RTC::DataOutPort::subscribeInterfaces ( const ConnectorProfile &  connector_profile  )  [protected, virtual]

Subscribe to the interface.

This operation is pure virutal function that would be called at the middle of the notify_connect() process sequence. In the notify_connect(), the following methods would be called in order.

Parameters:
connector_profile The connection profile information
Returns:
The return code of ReturnCode_t type.

Implements RTC::PortBase.

virtual void RTC::DataOutPort::unsubscribeInterfaces ( const ConnectorProfile &  connector_profile  )  [protected, virtual]

Disconnect the interface connection.

This operation is pure virutal function that would be called at the end of the notify_disconnect() process sequence. In the notify_disconnect(), the following methods would be called.

Parameters:
connector_profile The profile information associated with the connection

Implements RTC::PortBase.


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