Public Member Functions | Private Member Functions | Private Attributes | List of all members
RTC::InPortCorbaCdrConsumer Class Reference

InPortCorbaCdrConsumer class. More...

#include <InPortCorbaCdrConsumer.h>

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

Public Member Functions

virtual void init (coil::Properties &prop)
 Initializing configuration. More...
 
DATAPORTSTATUS_ENUM InPortCorbaCdrConsumer (void)
 Constructor. More...
 
virtual void publishInterfaceProfile (SDOPackage::NVList &properties)
 Publish InterfaceProfile information. More...
 
virtual ReturnCode put (const cdrMemoryStream &data)
 Send data to the destination port. 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...
 
virtual ~InPortCorbaCdrConsumer (void)
 Destructor. More...
 
- Public Member Functions inherited from RTC::InPortConsumer
virtual DATAPORTSTATUS_ENUM ~InPortConsumer (void)
 Destructor. More...
 
- Public Member Functions inherited from RTC::CorbaConsumer< ::OpenRTM::InPortCdr >
typename ::OpenRTM::InPortCdr ::_ptr_type _ptr ()
 Get Object reference narrowed as ObjectType. More...
 
 CorbaConsumer ()
 Consructor. More...
 
 CorbaConsumer (const CorbaConsumer &x)
 Copy constructor. More...
 
typename ::OpenRTM::InPortCdr ::_ptr_type operator-> ()
 Get Object reference narrowed as ObjectType. More...
 
CorbaConsumeroperator= (const CorbaConsumer &x)
 Assignment operator. More...
 
virtual void releaseObject ()
 Clear CORBA object setting. More...
 
virtual bool setObject (CORBA::Object_ptr obj)
 Set Object. More...
 
void swap (CorbaConsumer &x)
 
virtual ~CorbaConsumer (void)
 Virtual destructor. More...
 
- Public Member Functions inherited from RTC::CorbaConsumerBase
 CorbaConsumerBase ()
 Consructor. More...
 
 CorbaConsumerBase (const CorbaConsumerBase &x)
 Copy Consructor. More...
 
virtual CORBA::Object_ptr getObject ()
 Get CORBA Object. More...
 
CorbaConsumerBaseoperator= (const CorbaConsumerBase &x)
 Assignment operator. More...
 
void swap (CorbaConsumerBase &x)
 swap function More...
 
virtual ~CorbaConsumerBase (void)
 Virtual destructor. More...
 

Private Member Functions

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

Private Attributes

coil::Properties m_properties
 
Logger rtclog
 

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...
 
- Protected Attributes inherited from RTC::CorbaConsumer< ::OpenRTM::InPortCdr >
typename ::OpenRTM::InPortCdr ::_var_type m_var
 CORBA object which has been set. More...
 
- Protected Attributes inherited from RTC::CorbaConsumerBase
CORBA::Object_var m_objref
 CORBA object which is set. More...
 

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

◆ InPortCorbaCdrConsumer()

RTC::InPortCorbaCdrConsumer::InPortCorbaCdrConsumer ( void  )

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.

◆ ~InPortCorbaCdrConsumer()

RTC::InPortCorbaCdrConsumer::~InPortCorbaCdrConsumer ( void  )
virtual

Destructor.

Destructor

Definition at line 45 of file InPortCorbaCdrConsumer.cpp.

Member Function Documentation

◆ convertReturnCode()

InPortConsumer::ReturnCode RTC::InPortCorbaCdrConsumer::convertReturnCode ( OpenRTM::PortStatus  ret)
private

Return codes conversion.

Definition at line 314 of file InPortCorbaCdrConsumer.cpp.

◆ init()

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.

Definition at line 57 of file InPortCorbaCdrConsumer.cpp.

◆ publishInterfaceProfile()

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.

◆ put()

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.

◆ subscribeFromIor()

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.

◆ subscribeFromRef()

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.

◆ subscribeInterface()

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.

◆ unsubscribeFromIor()

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.

◆ unsubscribeFromRef()

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.

◆ unsubscribeInterface()

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

◆ m_properties

coil::Properties RTC::InPortCorbaCdrConsumer::m_properties
private

Definition at line 300 of file InPortCorbaCdrConsumer.h.

◆ rtclog

Logger RTC::InPortCorbaCdrConsumer::rtclog
mutableprivate

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 Mon Feb 28 2022 23:00:47