OpenRTM  1.0.0
Public Member Functions
RTC::InPortCorbaCdrConsumer Class Reference

InPortCorbaCdrConsumer class. More...

#include <InPortCorbaCdrConsumer.h>

Inheritance diagram for RTC::InPortCorbaCdrConsumer:
RTC::InPortConsumer RTC::CorbaConsumer< ::OpenRTM::InPortCdr > RTC::DataPortStatus RTC::CorbaConsumerBase

List of all members.

Public Member Functions

DATAPORTSTATUS_ENUM InPortCorbaCdrConsumer (void)
 Constructor.
virtual ~InPortCorbaCdrConsumer (void)
 Destructor.
virtual void init (coil::Properties &prop)
 Initializing configuration.
virtual ReturnCode put (const cdrMemoryStream &data)
 Send data to the destination port.
virtual void publishInterfaceProfile (SDOPackage::NVList &properties)
 Publish InterfaceProfile information.
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

InPortCorbaCdrConsumer class.

The InPort consumer class which uses the OpenRTM::InPortCdr interface in CORBA for data transfer and realizes a push-type dataflow.

Since:
0.4.0

Constructor & Destructor Documentation

Constructor.

Constructor

Parameters:
bufferThe buffer object that is attached to this Consumer

Destructor.

Destructor


Member Function Documentation

virtual void RTC::InPortCorbaCdrConsumer::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:
propConfiguration information

Implements RTC::InPortConsumer.

virtual void RTC::InPortCorbaCdrConsumer::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:
propertiesProperties to get InterfaceProfile information

Implements RTC::InPortConsumer.

virtual ReturnCode RTC::InPortCorbaCdrConsumer::put ( const cdrMemoryStream &  data) [virtual]

Send data to the destination port.

Pure virtual function to send data to the destination port.

This function might the following return codes

  • PORT_OK: Normal return
  • PORT_ERROR: Error occurred in data transfer process
  • SEND_FULL: Buffer full although OutPort tried to send data
  • SEND_TIMEOUT: Timeout although OutPort tried to send data
  • UNKNOWN_ERROR: Unknown error

Implements RTC::InPortConsumer.

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

Subscribe to the data sending notification.

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

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

Implements RTC::InPortConsumer.

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

Unsubscribe the data send notification.

Unsubscribe the data send notification.

Parameters:
propertiesInformation for unsubscription

Implements RTC::InPortConsumer.