RTC::OutPortProvider Class Reference

OutPortProvider. More...

#include <OutPortProvider.h>

Inheritance diagram for RTC::OutPortProvider:

RTC::DataPortStatus RTC::OutPortCorbaCdrProvider

List of all members.

Public Member Functions

virtual DATAPORTSTATUS_ENUM ~OutPortProvider (void)
 Destructor.
virtual void init (coil::Properties &prop)
 Initializing configuration.
virtual void setBuffer (CdrBufferBase *buffer)=0
 Setting outside buffer's pointer.
virtual void setListener (ConnectorInfo &info, ConnectorListeners *listeners)=0
 Set the listener.
virtual void setConnector (OutPortConnector *connector)=0
 set Connector
virtual void publishInterfaceProfile (SDOPackage::NVList &properties)
 Publish InterfaceProfile information.
virtual bool publishInterface (SDOPackage::NVList &properties)
 Publish interface information.

Protected Member Functions

void setPortType (const char *port_type)
 Set the port type.
void setDataType (const char *data_type)
 Set the data type.
void setInterfaceType (const char *interface_type)
 Set the interface type.
void setDataFlowType (const char *dataflow_type)
 Set the data flow type.
void setSubscriptionType (const char *subs_type)
 Set the subscription type.

Protected Attributes

SDOPackage::NVList m_properties
 Properties to hold the port profiles.
Logger rtclog
 Logger stream.

Classes

struct  publishInterfaceFunc
 Functor to publish interface profile. More...
struct  publishInterfaceProfileFunc
 Functor to publish interface profile. More...


Detailed Description

OutPortProvider.

(Example) When OutPort is provided:

OutPortCorbaProvider declares the following:

OutPortRawTCPProvider declares the following:

Finally, PortProfile::properties declares the following:

Since:
0.4.0

Constructor & Destructor Documentation

virtual DATAPORTSTATUS_ENUM RTC::OutPortProvider::~OutPortProvider ( void   )  [virtual]

Destructor.


Member Function Documentation

virtual void RTC::OutPortProvider::init ( coil::Properties prop  )  [virtual]

Initializing configuration.

This operation would be called to configure in initialization. In the concrete class, configuration should be performed getting appropriate information from the given Properties data. This function might be called right after instantiation and connection sequence respectivly. Therefore, this function should be implemented assuming multiple call.

Parameters:
prop Configuration information

Reimplemented in RTC::OutPortCorbaCdrProvider.

virtual void RTC::OutPortProvider::setBuffer ( CdrBufferBase buffer  )  [pure virtual]

Setting outside buffer's pointer.

A pointer to a buffer from which OutPortProvider retrieve data. If already buffer is set, previous buffer's pointer will be overwritten by the given pointer to a buffer. Since OutPortProvider does not assume ownership of the buffer pointer, destructor of the buffer should be done by user.

Parameters:
buffer A pointer to a data buffer to be used by OutPortProvider

Implemented in RTC::OutPortCorbaCdrProvider.

virtual void RTC::OutPortProvider::setListener ( ConnectorInfo info,
ConnectorListeners listeners 
) [pure virtual]

Set the listener.

Implemented in RTC::OutPortCorbaCdrProvider.

virtual void RTC::OutPortProvider::setConnector ( OutPortConnector connector  )  [pure virtual]

set Connector

Implemented in RTC::OutPortCorbaCdrProvider.

virtual void RTC::OutPortProvider::publishInterfaceProfile ( SDOPackage::NVList &  properties  )  [virtual]

Publish InterfaceProfile information.

Publish interfaceProfile information. Check the dataport.interface_type value of the NameValue object specified by an argument in property information and get information only when the interface type of the specified port is matched.

Parameters:
properties Properties to get InterfaceProfile information

Referenced by RTC::OutPortProvider::publishInterfaceProfileFunc::operator()().

virtual bool RTC::OutPortProvider::publishInterface ( SDOPackage::NVList &  properties  )  [virtual]

Publish interface information.

Publish interface information. Check the dataport.interface_type value of the NameValue object specified by an argument in the property information, and add the information to the NameValue if this port is not specified. This does not do anything if the same interface is already subscribed.

Parameters:
properties Properties to receive interface information

Referenced by RTC::OutPortProvider::publishInterfaceFunc::operator()().

void RTC::OutPortProvider::setPortType ( const char *  port_type  )  [protected]

Set the port type.

Set the port type specified by the argument.

Parameters:
port_type The target port type to set

void RTC::OutPortProvider::setDataType ( const char *  data_type  )  [protected]

Set the data type.

Set the data type specified by the argument.

Parameters:
data_type The target data type to set

void RTC::OutPortProvider::setInterfaceType ( const char *  interface_type  )  [protected]

Set the interface type.

Set theinterface type specified by the argument.

Parameters:
interface_type The target interface type to set

void RTC::OutPortProvider::setDataFlowType ( const char *  dataflow_type  )  [protected]

Set the data flow type.

Set the data flow type specified by the argument.

Parameters:
dataflow_type The target data flow type to set

void RTC::OutPortProvider::setSubscriptionType ( const char *  subs_type  )  [protected]

Set the subscription type.

Set the subscription type specified by the argument.

Parameters:
subs_type The target subscription type to set


Member Data Documentation

SDOPackage::NVList RTC::OutPortProvider::m_properties [protected]

Properties to hold the port profiles.

Logger RTC::OutPortProvider::rtclog [mutable, protected]

Logger stream.


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