Public Member Functions | List of all members
OutPortProvider::OutPortProviderMock Class Reference
Inheritance diagram for OutPortProvider::OutPortProviderMock:
Inheritance graph

Public Member Functions

 OutPortProviderMock (const std::string &portType, const std::string &dataType, const std::string &interfaceType, const std::string &dataFlowType, const std::string &subscriptionType)
void setBuffer (RTC::CdrBufferBase *buffer)
 Setting outside buffer's pointer. More...
void setConnector (RTC::OutPortConnector *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::OutPortProvider
virtual void init (coil::Properties &prop)
 Initializing configuration. More...
virtual bool publishInterface (SDOPackage::NVList &properties)
 Publish interface information. More...
virtual void publishInterfaceProfile (SDOPackage::NVList &properties)
 Publish InterfaceProfile information. More...
virtual DATAPORTSTATUS_ENUM ~OutPortProvider (void)
 Destructor. More...

Additional Inherited Members

- Public Types inherited from RTC::DataPortStatus
enum  Enum {
 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::OutPortProvider
void setDataFlowType (const char *dataflow_type)
 Set the data flow type. More...
void setDataType (const char *data_type)
 Set the data type. More...
void setInterfaceType (const char *interface_type)
 Set the interface type. More...
void setPortType (const char *port_type)
 Set the port type. More...
void setSubscriptionType (const char *subs_type)
 Set the subscription type. More...
- Protected Attributes inherited from RTC::OutPortProvider
SDOPackage::NVList m_properties
 Properties to hold the port profiles. More...
Logger rtclog
 Logger stream. More...

Detailed Description

Definition at line 137 of file OutPortProviderTests.cpp.

Constructor & Destructor Documentation

OutPortProvider::OutPortProviderMock::OutPortProviderMock ( const std::string &  portType,
const std::string &  dataType,
const std::string &  interfaceType,
const std::string &  dataFlowType,
const std::string &  subscriptionType 

Definition at line 141 of file OutPortProviderTests.cpp.

Member Function Documentation

void OutPortProvider::OutPortProviderMock::setBuffer ( RTC::CdrBufferBase buffer)

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.

bufferA pointer to a data buffer to be used by OutPortProvider

Implements RTC::OutPortProvider.

Definition at line 162 of file OutPortProviderTests.cpp.

void OutPortProvider::OutPortProviderMock::setConnector ( RTC::OutPortConnector connector)

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.


Implements RTC::OutPortProvider.

Definition at line 169 of file OutPortProviderTests.cpp.

void OutPortProvider::OutPortProviderMock::setDummydataInProperties ( void  )

Definition at line 156 of file OutPortProviderTests.cpp.

void OutPortProvider::OutPortProviderMock::setListener ( RTC::ConnectorInfo info,
RTC::ConnectorListeners listeners 

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.

infoConnector information
listenersListener objects

Implements RTC::OutPortProvider.

Definition at line 166 of file OutPortProviderTests.cpp.

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

Author(s): Noriaki Ando
autogenerated on Mon Jun 10 2019 14:08:02