Public Member Functions | |
| void | init (coil::Properties &prop) |
| Initializing configuration. More... | |
| InPortProviderMock (const std::string &interfaceType, const std::string &dataFlowType, const std::string &subscriptionType) | |
| void | setBuffer (RTC::BufferBase< cdrMemoryStream > *buffer) |
| Setting outside buffer's pointer. More... | |
| void | setConnector (RTC::InPortConnector *connector) |
| set Connector More... | |
| void | setDummydataInProperties (void) |
| void | setListener (RTC::ConnectorInfo &info, RTC::ConnectorListeners *listeners) |
| Set the listener. More... | |
 Public Member Functions inherited from RTC::InPortProvider | |
| DATAPORTSTATUS_ENUM | InPortProvider () |
| Constructor. More... | |
| virtual bool | publishInterface (SDOPackage::NVList &properties) |
| Publish interface information. More... | |
| virtual void | publishInterfaceProfile (SDOPackage::NVList &properties) |
| Publish InterfaceProfile information. More... | |
| virtual | ~InPortProvider (void) |
| Destructor. 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... | |
| Protected Member Functions inherited from RTC::InPortProvider | |
| void | setDataFlowType (const char *dataflow_type) |
| Set the dataflow type. More... | |
| void | setInterfaceType (const char *interface_type) |
| Set the interface type. More... | |
| void | setSubscriptionType (const char *subs_type) |
| Set the subscription type. More... | |
| Protected Attributes inherited from RTC::InPortProvider | |
| SDOPackage::NVList | m_properties |
| Properties to hold port profile. More... | |
| Logger | rtclog |
| Logger stream. More... | |
Detailed Description
Definition at line 48 of file InPortProviderTests.cpp.
Constructor & Destructor Documentation
◆ InPortProviderMock()
|
inline |
Definition at line 52 of file InPortProviderTests.cpp.
Member Function Documentation
◆ init()
|
inlinevirtual |
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
-
prop Configuration information
Implements RTC::InPortProvider.
Definition at line 66 of file InPortProviderTests.cpp.
◆ setBuffer()
|
inlinevirtual |
Setting outside buffer's pointer.
A pointer to a buffer from which OutPortProvider retrieve data. If already buffer is set, previous buffer's pointer will be overwritten by the given pointer to a buffer. Since OutPortProvider does not assume ownership of the buffer pointer, destructor of the buffer should be done by user.
- Parameters
-
buffer A pointer to a data buffer to be used by OutPortProvider
Implements RTC::InPortProvider.
Definition at line 69 of file InPortProviderTests.cpp.
◆ setConnector()
|
inlinevirtual |
set Connector
OutPort creates OutPortConnector object when it establishes connection between OutPort and InPort, and it calls this function with a pointer to the connector object. Since the OutPort has the ownership of this connector, OutPortProvider should not delete it.
- Parameters
-
connector OutPortConnector
Implements RTC::InPortProvider.
Definition at line 76 of file InPortProviderTests.cpp.
◆ setDummydataInProperties()
|
inline |
Definition at line 61 of file InPortProviderTests.cpp.
◆ setListener()
|
inlinevirtual |
Set the listener.
OutPort provides callback functionality that calls specific listener objects according to the events in the data publishing process. For details, see documentation of ConnectorDataListener class and ConnectorListener class in ConnectorListener.h. In the sub-classes of OutPortProvider, the given listeners should be called in the proper timing. However, it is not necessary to call all the listeners.
- Parameters
-
info Connector information listeners Listener objects
Implements RTC::InPortProvider.
Definition at line 72 of file InPortProviderTests.cpp.
The documentation for this class was generated from the following file: