OpenRTM-aist 2.0.2
|
InPortConsumer abstract class. More...
#include <InPortConsumer.h>
Classes | |
struct | publishInterfaceProfileFunc |
Functor to publish interface profile . More... | |
struct | subscribeInterfaceFunc |
Functor to publish interface profile . More... | |
Public Member Functions | |
virtual | ~InPortConsumer ()=default |
Destructor. | |
virtual void | init (coil::Properties &prop)=0 |
Initializing configuration. | |
virtual DataPortStatus | put (ByteData &data)=0 |
Send data to the destination port. | |
virtual void | publishInterfaceProfile (SDOPackage::NVList &properties)=0 |
Publish InterfaceProfile information. | |
virtual bool | subscribeInterface (const SDOPackage::NVList &properties)=0 |
Subscribe the data send notification. | |
virtual void | unsubscribeInterface (const SDOPackage::NVList &properties)=0 |
Unsubscribe the data send notification. | |
InPortConsumer abstract class.
This is the abstract interface class for the input port Consumer. Concrete classes must implement the following pure virtual functions.
|
virtualdefault |
Destructor.
Destructor
|
pure virtual |
Initializing configuration.
This operation would be called to configure this consumer in initialization.
Implemented in RTC::InPortCorbaCdrConsumer, RTC::InPortCorbaCdrUDPConsumer, RTC::InPortDirectConsumer, RTC::InPortDSConsumer, and RTC::InPortSHMConsumer.
|
pure 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.
properties | Properties to get InterfaceProfile information |
Implemented in RTC::InPortCorbaCdrConsumer, RTC::InPortCorbaCdrUDPConsumer, RTC::InPortDirectConsumer, RTC::InPortDSConsumer, and RTC::InPortSHMConsumer.
Referenced by RTC::InPortConsumer::publishInterfaceProfileFunc::operator()().
|
pure virtual |
Send data to the destination port.
Pure virtual function to send data to the destination port.
This function might the following return codes
Implemented in RTC::InPortCorbaCdrConsumer, RTC::InPortCorbaCdrUDPConsumer, RTC::InPortDirectConsumer, RTC::InPortDSConsumer, and RTC::InPortSHMConsumer.
|
pure virtual |
Subscribe the data send notification.
Pure virtual function to subscribe the data send notification based on specified property information.
properties | Properties for reference when subscribing |
Implemented in RTC::InPortCorbaCdrConsumer, RTC::InPortCorbaCdrUDPConsumer, RTC::InPortDirectConsumer, RTC::InPortDSConsumer, and RTC::InPortSHMConsumer.
Referenced by RTC::InPortConsumer::subscribeInterfaceFunc::operator()().
|
pure virtual |
Unsubscribe the data send notification.
Pure virtual function to unsubscribe the data send notification.
properties | Properties for reference when unsubscribing |
Implemented in RTC::InPortCorbaCdrConsumer, RTC::InPortCorbaCdrUDPConsumer, RTC::InPortDirectConsumer, RTC::InPortDSConsumer, and RTC::InPortSHMConsumer.