Public Member Functions | Private Member Functions | Private Attributes
RTC::InPortCorbaCdrConsumer Class Reference

InPortCorbaCdrConsumer class. More...

#include <InPortCorbaCdrConsumer.h>

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

List of all members.

Public Member Functions

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

Private Member Functions

InPortConsumer::ReturnCode convertReturnCode (OpenRTM::PortStatus ret)
 Return codes conversion.
bool subscribeFromIor (const SDOPackage::NVList &properties)
 Getting object reference fromn IOR string.
bool subscribeFromRef (const SDOPackage::NVList &properties)
 Getting object reference fromn Any directry.
bool unsubscribeFromIor (const SDOPackage::NVList &properties)
 ubsubscribing (IOR version)
bool unsubscribeFromRef (const SDOPackage::NVList &properties)
 ubsubscribing (Object reference version)

Private Attributes

coil::Properties m_properties
Logger rtclog

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

Definition at line 57 of file InPortCorbaCdrConsumer.h.


Constructor & Destructor Documentation

Constructor.

Constructor

Parameters:
bufferThe buffer object that is attached to this Consumer
bufferThe buffer object that is attached to this Consumer

Definition at line 33 of file InPortCorbaCdrConsumer.cpp.

Destructor.

Destructor

Definition at line 45 of file InPortCorbaCdrConsumer.cpp.


Member Function Documentation

Return codes conversion.

Definition at line 314 of file InPortCorbaCdrConsumer.cpp.

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.

Definition at line 57 of file InPortCorbaCdrConsumer.cpp.

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.

Definition at line 106 of file InPortCorbaCdrConsumer.cpp.

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

Send data to the destination port.

Write data into the buffer.

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.

Reimplemented in PublisherNew::InPortCorbaCdrConsumerMock, PublisherPeriodic::InPortCorbaCdrConsumerMock, and PublisherFlush::InPortCorbaCdrConsumerMock.

Definition at line 70 of file InPortCorbaCdrConsumer.cpp.

bool RTC::InPortCorbaCdrConsumer::subscribeFromIor ( const SDOPackage::NVList &  properties) [private]

Getting object reference fromn IOR string.

Returns:
true: succeeded, false: failed

Definition at line 161 of file InPortCorbaCdrConsumer.cpp.

bool RTC::InPortCorbaCdrConsumer::subscribeFromRef ( const SDOPackage::NVList &  properties) [private]

Getting object reference fromn Any directry.

Returns:
true: succeeded, false: failed

Definition at line 206 of file InPortCorbaCdrConsumer.cpp.

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.

Definition at line 119 of file InPortCorbaCdrConsumer.cpp.

bool RTC::InPortCorbaCdrConsumer::unsubscribeFromIor ( const SDOPackage::NVList &  properties) [private]

ubsubscribing (IOR version)

Returns:
true: succeeded, false: failed

Definition at line 247 of file InPortCorbaCdrConsumer.cpp.

bool RTC::InPortCorbaCdrConsumer::unsubscribeFromRef ( const SDOPackage::NVList &  properties) [private]

ubsubscribing (Object reference version)

Returns:
true: succeeded, false: failed

Definition at line 286 of file InPortCorbaCdrConsumer.cpp.

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.

Definition at line 141 of file InPortCorbaCdrConsumer.cpp.


Member Data Documentation

Definition at line 300 of file InPortCorbaCdrConsumer.h.

Definition at line 299 of file InPortCorbaCdrConsumer.h.


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


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