OpenRTM-aist 2.1.0
Loading...
Searching...
No Matches
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

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

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

◆ InPortDirectConsumer()

RTC::InPortDirectConsumer::InPortDirectConsumer ( )

Constructor.

◆ ~InPortDirectConsumer()

RTC::InPortDirectConsumer::~InPortDirectConsumer ( )
override

Destructor.

Member Function Documentation

◆ init()

void RTC::InPortDirectConsumer::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::InPortConsumer.

◆ publishInterfaceProfile()

void RTC::InPortDirectConsumer::publishInterfaceProfile ( SDOPackage::NVList &  properties)
overridevirtual

Publish InterfaceProfile information.

Implements RTC::InPortConsumer.

◆ put()

DataPortStatus RTC::InPortDirectConsumer::put ( ByteData data)
overridevirtual

Send data to the destination port.

Implements RTC::InPortConsumer.

◆ subscribeInterface()

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

Subscribe to the data sending notification.

Implements RTC::InPortConsumer.

◆ unsubscribeInterface()

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

Unsubscribe the data send notification.

Implements RTC::InPortConsumer.


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