OpenRTM-aist 2.1.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
RTC::OutPortDSConsumer Class Reference

OutPortDSConsumer class. More...

#include <OutPortDSConsumer.h>

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

Public Member Functions

 OutPortDSConsumer ()
 Constructor.
 
 ~OutPortDSConsumer () override
 Destructor.
 
void init (coil::Properties &prop) override
 Initializing configuration.
 
void setBuffer (CdrBufferBase *buffer) override
 Setting outside buffer's pointer.
 
void setListener (ConnectorInfo &info, ConnectorListenersBase *listeners) override
 Set the listener.
 
DataPortStatus get (ByteData &data) override
 Read data.
 
bool subscribeInterface (const SDOPackage::NVList &properties) override
 Subscribe the data receive notification.
 
void unsubscribeInterface (const SDOPackage::NVList &properties) override
 Unsubscribe the data receive notification.
 
- Public Member Functions inherited from RTC::OutPortConsumer
virtual ~OutPortConsumer ()=default
 Destructor.
 
- Public Member Functions inherited from RTC::CorbaConsumer< ::RTC::DataPullService >
 CorbaConsumer ()
 Consructor.
 
 CorbaConsumer (const CorbaConsumer &x)
 Copy constructor.
 
CorbaConsumeroperator= (const CorbaConsumer &x)
 Assignment operator.
 
void swap (CorbaConsumer &x)
 
 ~CorbaConsumer () override
 Virtual destructor.
 
bool setObject (CORBA::Object_ptr obj) override
 Set Object.
 
typename ObjectType::_ptr_type _ptr ()
 Get Object reference narrowed as ObjectType.
 
typename ObjectType::_ptr_type operator-> ()
 Get Object reference narrowed as ObjectType.
 
void releaseObject () override
 Clear CORBA object setting.
 
- Public Member Functions inherited from RTC::CorbaConsumerBase
 CorbaConsumerBase ()=default
 Consructor.
 
 CorbaConsumerBase (const CorbaConsumerBase &x)
 Copy Consructor.
 
CorbaConsumerBaseoperator= (const CorbaConsumerBase &x)
 Assignment operator.
 
void swap (CorbaConsumerBase &x)
 swap function
 
virtual ~CorbaConsumerBase ()
 Virtual destructor.
 
virtual CORBA::Object_ptr getObject ()
 Get CORBA Object.
 

Protected Attributes

Logger rtclog
 Logger stream .
 
- Protected Attributes inherited from RTC::CorbaConsumer< ::RTC::DataPullService >
typename ObjectType::_var_type m_var
 CORBA object which has been set. .
 
- Protected Attributes inherited from RTC::CorbaConsumerBase
CORBA::Object_var m_objref
 CORBA object which is set. .
 

Detailed Description

OutPortDSConsumer class.

The OutPort consumer class which uses the RTC::DataPullService interface in CORBA for data transfer and realizes a pull-type dataflow.

Since
2.0.0

Constructor & Destructor Documentation

◆ OutPortDSConsumer()

RTC::OutPortDSConsumer::OutPortDSConsumer ( )

Constructor.

◆ ~OutPortDSConsumer()

RTC::OutPortDSConsumer::~OutPortDSConsumer ( )
override

Destructor.

Member Function Documentation

◆ get()

DataPortStatus RTC::OutPortDSConsumer::get ( ByteData data)
overridevirtual

Read data.

Implements RTC::OutPortConsumer.

◆ init()

void RTC::OutPortDSConsumer::init ( coil::Properties &  prop)
overridevirtual

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::OutPortConsumer.

◆ setBuffer()

void RTC::OutPortDSConsumer::setBuffer ( CdrBufferBase buffer)
overridevirtual

Setting outside buffer's pointer.

Implements RTC::OutPortConsumer.

◆ setListener()

void RTC::OutPortDSConsumer::setListener ( ConnectorInfo info,
ConnectorListenersBase listeners 
)
overridevirtual

Set the listener.

Implements RTC::OutPortConsumer.

◆ subscribeInterface()

bool RTC::OutPortDSConsumer::subscribeInterface ( const SDOPackage::NVList &  properties)
overridevirtual

Subscribe the data receive notification.

Implements RTC::OutPortConsumer.

◆ unsubscribeInterface()

void RTC::OutPortDSConsumer::unsubscribeInterface ( const SDOPackage::NVList &  properties)
overridevirtual

Unsubscribe the data receive notification.

Implements RTC::OutPortConsumer.

Member Data Documentation

◆ rtclog

Logger RTC::OutPortDSConsumer::rtclog
mutableprotected

Logger stream .


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