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

OutPortDirectConsumer class. More...

#include <OutPortDirectConsumer.h>

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

Public Member Functions

 OutPortDirectConsumer ()
 Constructor.
 
 ~OutPortDirectConsumer () 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.
 

Detailed Description

OutPortDirectConsumer class.

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

Since
1.2.0

Constructor & Destructor Documentation

◆ OutPortDirectConsumer()

RTC::OutPortDirectConsumer::OutPortDirectConsumer ( )

Constructor.

◆ ~OutPortDirectConsumer()

RTC::OutPortDirectConsumer::~OutPortDirectConsumer ( )
override

Destructor.

Member Function Documentation

◆ get()

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

Read data.

Implements RTC::OutPortConsumer.

◆ init()

void RTC::OutPortDirectConsumer::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::OutPortDirectConsumer::setBuffer ( CdrBufferBase buffer)
overridevirtual

Setting outside buffer's pointer.

Implements RTC::OutPortConsumer.

◆ setListener()

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

Set the listener.

Implements RTC::OutPortConsumer.

◆ subscribeInterface()

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

Subscribe the data receive notification.

Implements RTC::OutPortConsumer.

◆ unsubscribeInterface()

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

Unsubscribe the data receive notification.

Implements RTC::OutPortConsumer.


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