OpenRTM-aist  1.2.1
Public Member Functions | List of all members
RTC::InPortDirectConsumer Class Reference

InPortDirectConsumer class. More...

#include <InPortDirectConsumer.h>

Inheritance diagram for RTC::InPortDirectConsumer:
Inheritance graph
[legend]
Collaboration diagram for RTC::InPortDirectConsumer:
Collaboration graph
[legend]

Public Member Functions

DATAPORTSTATUS_ENUM InPortDirectConsumer (void)
 Constructor. More...
 
virtual ~InPortDirectConsumer (void)
 Destructor. More...
 
virtual void init (coil::Properties &prop)
 Initializing configuration. More...
 
virtual ReturnCode put (cdrMemoryStream &data)
 Send data to the destination port. More...
 
virtual void publishInterfaceProfile (SDOPackage::NVList &properties)
 Publish InterfaceProfile information. More...
 
virtual bool subscribeInterface (const SDOPackage::NVList &properties)
 Subscribe to the data sending notification. More...
 
virtual void unsubscribeInterface (const SDOPackage::NVList &properties)
 Unsubscribe the data send notification. More...
 
- Public Member Functions inherited from RTC::InPortConsumer
virtual DATAPORTSTATUS_ENUM ~InPortConsumer (void)
 Destructor. More...
 

Additional Inherited Members

- Public Types inherited from RTC::DataPortStatus
enum  Enum {
  PORT_OK = 0, PORT_ERROR, BUFFER_ERROR, BUFFER_FULL,
  BUFFER_EMPTY, BUFFER_TIMEOUT, SEND_FULL, SEND_TIMEOUT,
  RECV_EMPTY, RECV_TIMEOUT, INVALID_ARGS, PRECONDITION_NOT_MET,
  CONNECTION_LOST, UNKNOWN_ERROR
}
 DataPortStatus return codes. More...
 
- Static Public Member Functions inherited from RTC::DataPortStatus
static const char * toString (DataPortStatus::Enum status)
 Convert DataPortStatus into the string. More...
 

Detailed Description

InPortDirectConsumer 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

DATAPORTSTATUS_ENUM RTC::InPortDirectConsumer::InPortDirectConsumer ( void  )

Constructor.

Constructor

Parameters
bufferThe buffer object that is attached to this Consumer
virtual RTC::InPortDirectConsumer::~InPortDirectConsumer ( void  )
virtual

Destructor.

Destructor

Member Function Documentation

virtual void RTC::InPortDirectConsumer::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::InPortDirectConsumer::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::InPortDirectConsumer::put ( 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::InPortDirectConsumer::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::InPortDirectConsumer::unsubscribeInterface ( const SDOPackage::NVList &  properties)
virtual

Unsubscribe the data send notification.

Unsubscribe the data send notification.

Parameters
propertiesInformation for unsubscription

Implements RTC::InPortConsumer.


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