OpenRTM-aist
1.2.1
|
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 DATAPORTSTATUS_ENUM | ~InPortConsumer (void) |
Destructor. More... | |
virtual void | init (coil::Properties &prop)=0 |
Initializing configuration. More... | |
virtual ReturnCode | put (cdrMemoryStream &data)=0 |
Send data to the destination port. More... | |
virtual void | publishInterfaceProfile (SDOPackage::NVList &properties)=0 |
Publish InterfaceProfile information. More... | |
virtual bool | subscribeInterface (const SDOPackage::NVList &properties)=0 |
Subscribe the data send notification. More... | |
virtual void | unsubscribeInterface (const SDOPackage::NVList &properties)=0 |
Unsubscribe the data send notification. More... | |
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... | |
InPortConsumer abstract class.
This is the abstract interface class for the input port Consumer. Concrete classes must implement the following pure virtual functions.
|
inlinevirtual |
Destructor.
Destructor
|
pure virtual |
Initializing configuration.
This operation would be called to configure this consumer in initialization.
Implemented in RTC::InPortCorbaCdrConsumer, RTC::InPortDirectConsumer, 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::InPortDirectConsumer, 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::InPortDirectConsumer, 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::InPortDirectConsumer, 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::InPortDirectConsumer, and RTC::InPortSHMConsumer.