RTC::DataInPort Class Reference

Port for InPort. More...

#include <DataInPort.h>

Inheritance diagram for RTC::DataInPort:

RTC::PortBase

List of all members.

Public Member Functions

template<class DataType, template< class DataType > class Buffer>
 DataInPort (const char *name, InPort< DataType, Buffer > &inport, Properties &prop)
 Constructor.
virtual ~DataInPort ()
 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.


Detailed Description

Port for InPort.

This is an implementation class for the data input port.

Since:
0.4.0

Constructor & Destructor Documentation

template<class DataType, template< class DataType > class Buffer>
RTC::DataInPort::DataInPort ( const char *  name,
InPort< DataType, Buffer > &  inport,
Properties prop 
) [inline]

Constructor.

Constructor

Parameters:
name Port name
inport InPort object that is associated with this data input port. Specify also the data type and the buffer type used in the InPort object.
prop Property for setting ports

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

Destructor.

Destructor


Member Function Documentation

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

Publish interface information.

Publish interface information. Assign the Provider information that owned by this port to ConnectorProfile::properties

Parameters:
connector_profile The connector profile
Returns:
The return code of ReturnCode_t type

Implements RTC::PortBase.

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

Subscribe to the interface.

Subscribe to interface. Derive Provider information that matches Consumer owned by the Port from ConnectorProfile::properties and set the Consumer to the reference of the CORBA object.

Parameters:
connector_profile The connector profile
Returns:
ReturnCode_t The return code of ReturnCode_t type

Implements RTC::PortBase.

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

Disconnect the interface connection.

Disconnect the interface connection. Release all objects set in Consumer associated with given ConnectorProfile and unscribe the interface.

Parameters:
connector_profile The connector profile

Implements RTC::PortBase.


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