Classes | Public Member Functions
RTC::InPortConsumer Class Reference

InPortConsumer abstract class. More...

#include <InPortConsumer.h>

Inheritance diagram for RTC::InPortConsumer:
Inheritance graph
[legend]

List of all members.

Classes

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

Public Member Functions

virtual void init (coil::Properties &prop)=0
 Initializing configuration.
virtual void publishInterfaceProfile (SDOPackage::NVList &properties)=0
 Publish InterfaceProfile information.
virtual ReturnCode put (const cdrMemoryStream &data)=0
 Send data to the destination port.
virtual bool subscribeInterface (const SDOPackage::NVList &properties)=0
 Subscribe the data send notification.
virtual void unsubscribeInterface (const SDOPackage::NVList &properties)=0
 Unsubscribe the data send notification.
virtual DATAPORTSTATUS_ENUM ~InPortConsumer (void)
 Destructor.

Detailed Description

InPortConsumer abstract class.

This is the abstract interface class for the input port Consumer. Concrete classes must implement the following pure virtual functions.

Since:
0.4.0

Definition at line 76 of file InPortConsumer.h.


Constructor & Destructor Documentation

virtual DATAPORTSTATUS_ENUM RTC::InPortConsumer::~InPortConsumer ( void  ) [inline, virtual]

Destructor.

Destructor

Definition at line 95 of file InPortConsumer.h.


Member Function Documentation

virtual void RTC::InPortConsumer::init ( coil::Properties prop) [pure virtual]
virtual void RTC::InPortConsumer::publishInterfaceProfile ( SDOPackage::NVList &  properties) [pure 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

Implemented in OutPortBase::InPortCorbaCdrConsumerMock, PublisherPeriodic::CounterConsumer, PublisherPeriodic::MockConsumer, RTC::InPortCorbaCdrConsumer, OutPort::InPortCorbaCdrConsumerMock, and OutPortPushConnector::InPortCorbaCdrConsumerMock.

virtual ReturnCode RTC::InPortConsumer::put ( const cdrMemoryStream &  data) [pure 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
  • CONNECTION_LOST: Connection lost
  • UNKNOWN_ERROR: Unknown error

Implemented in OutPortBase::InPortCorbaCdrConsumerMock, PublisherPeriodic::CounterConsumer, PublisherPeriodic::MockConsumer, OutPort::InPortCorbaCdrConsumerMock, OutPortPushConnector::InPortCorbaCdrConsumerMock, RTC::InPortCorbaCdrConsumer, PublisherNew::InPortCorbaCdrConsumerMock, PublisherPeriodic::InPortCorbaCdrConsumerMock, and PublisherFlush::InPortCorbaCdrConsumerMock.

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

Subscribe the data send notification.

Pure virtual function to subscribe the data send notification based on specified property information.

Parameters:
propertiesProperties for reference when subscribing
Returns:
Subscription result

Implemented in OutPortBase::InPortCorbaCdrConsumerMock, PublisherPeriodic::CounterConsumer, PublisherPeriodic::MockConsumer, RTC::InPortCorbaCdrConsumer, OutPort::InPortCorbaCdrConsumerMock, and OutPortPushConnector::InPortCorbaCdrConsumerMock.

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

Unsubscribe the data send notification.

Pure virtual function to unsubscribe the data send notification.

Parameters:
propertiesProperties for reference when unsubscribing

Implemented in OutPortBase::InPortCorbaCdrConsumerMock, PublisherPeriodic::CounterConsumer, PublisherPeriodic::MockConsumer, RTC::InPortCorbaCdrConsumer, OutPort::InPortCorbaCdrConsumerMock, and OutPortPushConnector::InPortCorbaCdrConsumerMock.


The documentation for this class was generated from the following file:


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Thu Aug 27 2015 14:16:41