Public Member Functions | Private Attributes | List of all members
OutPortBase::OutPortCorbaCdrProviderMock Class Reference
Inheritance diagram for OutPortBase::OutPortCorbaCdrProviderMock:
Inheritance graph
[legend]

Public Member Functions

virtual ::OpenRTM::PortStatus get (::OpenRTM::CdrData_out data)
 
void init (coil::Properties &prop)
 Initializing configuration. More...
 
 OutPortCorbaCdrProviderMock (void)
 
bool publishInterface (SDOPackage::NVList &prop)
 Publish interface information. More...
 
void publishInterfaceProfile (SDOPackage::NVList &properties)
 Publish InterfaceProfile information. More...
 
RTC::InPortConsumer::ReturnCode put (const cdrMemoryStream &data)
 
void setBuffer (RTC::CdrBufferBase *buffer)
 Setting outside buffer's pointer. More...
 
void setConnector (RTC::OutPortConnector *connector)
 set Connector More...
 
void setListener (RTC::ConnectorInfo &info, RTC::ConnectorListeners *listeners)
 Set the listener. More...
 
void setLogger (Logger *logger)
 
bool subscribeInterface (const SDOPackage::NVList &properties)
 
void unsubscribeInterface (const SDOPackage::NVList &properties)
 
virtual ~OutPortCorbaCdrProviderMock (void)
 
- Public Member Functions inherited from RTC::OutPortProvider
virtual DATAPORTSTATUS_ENUM ~OutPortProvider (void)
 Destructor. More...
 

Private Attributes

Loggerm_logger
 

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::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 692 of file OutPortBaseTests.cpp.

Constructor & Destructor Documentation

◆ OutPortCorbaCdrProviderMock()

OutPortBase::OutPortCorbaCdrProviderMock::OutPortCorbaCdrProviderMock ( void  )
inline

Definition at line 699 of file OutPortBaseTests.cpp.

◆ ~OutPortCorbaCdrProviderMock()

virtual OutPortBase::OutPortCorbaCdrProviderMock::~OutPortCorbaCdrProviderMock ( void  )
inlinevirtual

Definition at line 704 of file OutPortBaseTests.cpp.

Member Function Documentation

◆ get()

virtual ::OpenRTM::PortStatus OutPortBase::OutPortCorbaCdrProviderMock::get ( ::OpenRTM::CdrData_out  data)
inline

Definition at line 746 of file OutPortBaseTests.cpp.

◆ init()

void OutPortBase::OutPortCorbaCdrProviderMock::init ( coil::Properties prop)
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
propConfiguration information

Reimplemented from RTC::OutPortProvider.

Definition at line 711 of file OutPortBaseTests.cpp.

◆ publishInterface()

bool OutPortBase::OutPortCorbaCdrProviderMock::publishInterface ( SDOPackage::NVList &  properties)
inlinevirtual

Publish interface information.

Publish interface information. Check the dataport.interface_type value of the NameValue object specified by an argument in the property information, and add the information to the NameValue if this port is not specified. This does not do anything if the same interface is already subscribed.

Parameters
propertiesProperties to receive interface information
Returns
true: normal return

Reimplemented from RTC::OutPortProvider.

Definition at line 788 of file OutPortBaseTests.cpp.

◆ publishInterfaceProfile()

void OutPortBase::OutPortCorbaCdrProviderMock::publishInterfaceProfile ( SDOPackage::NVList &  properties)
inlinevirtual

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.

Parameters
propertiesProperties to get InterfaceProfile information

Reimplemented from RTC::OutPortProvider.

Definition at line 762 of file OutPortBaseTests.cpp.

◆ put()

RTC::InPortConsumer::ReturnCode OutPortBase::OutPortCorbaCdrProviderMock::put ( const cdrMemoryStream &  data)
inline

Definition at line 754 of file OutPortBaseTests.cpp.

◆ setBuffer()

void OutPortBase::OutPortCorbaCdrProviderMock::setBuffer ( RTC::CdrBufferBase buffer)
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
bufferA pointer to a data buffer to be used by OutPortProvider

Implements RTC::OutPortProvider.

Definition at line 723 of file OutPortBaseTests.cpp.

◆ setConnector()

void OutPortBase::OutPortCorbaCdrProviderMock::setConnector ( RTC::OutPortConnector connector)
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
connectorOutPortConnector

Implements RTC::OutPortProvider.

Definition at line 737 of file OutPortBaseTests.cpp.

◆ setListener()

void OutPortBase::OutPortCorbaCdrProviderMock::setListener ( RTC::ConnectorInfo info,
RTC::ConnectorListeners listeners 
)
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
infoConnector information
listenersListener objects

Implements RTC::OutPortProvider.

Definition at line 731 of file OutPortBaseTests.cpp.

◆ setLogger()

void OutPortBase::OutPortCorbaCdrProviderMock::setLogger ( Logger logger)
inline

Definition at line 797 of file OutPortBaseTests.cpp.

◆ subscribeInterface()

bool OutPortBase::OutPortCorbaCdrProviderMock::subscribeInterface ( const SDOPackage::NVList &  properties)
inline

Definition at line 771 of file OutPortBaseTests.cpp.

◆ unsubscribeInterface()

void OutPortBase::OutPortCorbaCdrProviderMock::unsubscribeInterface ( const SDOPackage::NVList &  properties)
inline

Definition at line 781 of file OutPortBaseTests.cpp.

Member Data Documentation

◆ m_logger

Logger* OutPortBase::OutPortCorbaCdrProviderMock::m_logger
private

Definition at line 802 of file OutPortBaseTests.cpp.


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


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Mon Feb 28 2022 23:00:47