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

Public Member Functions

virtual ReturnCode get (cdrMemoryStream &data)
 Receive data. More...
 
void init (coil::Properties &prop)
 Initializing configuration. More...
 
 OutPortCorbaCdrConsumerMock (void)
 
void publishInterfaceProfile (SDOPackage::NVList &properties)
 
::OpenRTM::PortStatus put (const ::OpenRTM::CdrData &data) throw (CORBA::SystemException)
 
RTC::OutPortConsumer::ReturnCode put (const cdrMemoryStream &data)
 
void setBuffer (RTC::BufferBase< cdrMemoryStream > *buffer)
 Setting outside buffer's pointer. More...
 
void setListener (RTC::ConnectorInfo &info, RTC::ConnectorListeners *listeners)
 Set the listener. More...
 
void setLogger (Logger *logger)
 
bool subscribeInterface (const SDOPackage::NVList &properties)
 Subscribe the data receive notification. More...
 
void unsubscribeInterface (const SDOPackage::NVList &properties)
 Unsubscribe the data receive notification. More...
 
virtual ~OutPortCorbaCdrConsumerMock (void)
 
- Public Member Functions inherited from RTC::OutPortConsumer
virtual DATAPORTSTATUS_ENUM ~OutPortConsumer (void)
 Destructor. More...
 
- Public Member Functions inherited from RTC::CorbaConsumer< ::OpenRTM::OutPortCdr >
typename ::OpenRTM::OutPortCdr ::_ptr_type _ptr ()
 Get Object reference narrowed as ObjectType. More...
 
 CorbaConsumer ()
 Consructor. More...
 
 CorbaConsumer (const CorbaConsumer &x)
 Copy constructor. More...
 
typename ::OpenRTM::OutPortCdr ::_ptr_type operator-> ()
 Get Object reference narrowed as ObjectType. More...
 
CorbaConsumeroperator= (const CorbaConsumer &x)
 Assignment operator. More...
 
virtual void releaseObject ()
 Clear CORBA object setting. More...
 
virtual bool setObject (CORBA::Object_ptr obj)
 Set Object. More...
 
void swap (CorbaConsumer &x)
 
virtual ~CorbaConsumer (void)
 Virtual destructor. More...
 
- Public Member Functions inherited from RTC::CorbaConsumerBase
 CorbaConsumerBase ()
 Consructor. More...
 
 CorbaConsumerBase (const CorbaConsumerBase &x)
 Copy Consructor. More...
 
virtual CORBA::Object_ptr getObject ()
 Get CORBA Object. More...
 
CorbaConsumerBaseoperator= (const CorbaConsumerBase &x)
 Assignment operator. More...
 
void swap (CorbaConsumerBase &x)
 swap function More...
 
virtual ~CorbaConsumerBase (void)
 Virtual 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 Attributes inherited from RTC::OutPortConsumer
Logger rtclog
 Logger stream. More...
 
- Protected Attributes inherited from RTC::CorbaConsumer< ::OpenRTM::OutPortCdr >
typename ::OpenRTM::OutPortCdr ::_var_type m_var
 CORBA object which has been set. More...
 
- Protected Attributes inherited from RTC::CorbaConsumerBase
CORBA::Object_var m_objref
 CORBA object which is set. More...
 

Detailed Description

Definition at line 504 of file InPortBaseTests.cpp.

Constructor & Destructor Documentation

◆ OutPortCorbaCdrConsumerMock()

InPortBase::OutPortCorbaCdrConsumerMock::OutPortCorbaCdrConsumerMock ( void  )
inline

Definition at line 510 of file InPortBaseTests.cpp.

◆ ~OutPortCorbaCdrConsumerMock()

virtual InPortBase::OutPortCorbaCdrConsumerMock::~OutPortCorbaCdrConsumerMock ( void  )
inlinevirtual

Definition at line 514 of file InPortBaseTests.cpp.

Member Function Documentation

◆ get()

virtual ReturnCode InPortBase::OutPortCorbaCdrConsumerMock::get ( cdrMemoryStream &  data)
inlinevirtual

Receive data.

Pure virtual function to receive data.

Implements RTC::OutPortConsumer.

Definition at line 586 of file InPortBaseTests.cpp.

◆ init()

void InPortBase::OutPortCorbaCdrConsumerMock::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

Implements RTC::OutPortConsumer.

Definition at line 541 of file InPortBaseTests.cpp.

◆ publishInterfaceProfile()

void InPortBase::OutPortCorbaCdrConsumerMock::publishInterfaceProfile ( SDOPackage::NVList &  properties)
inline

Definition at line 560 of file InPortBaseTests.cpp.

◆ put() [1/2]

::OpenRTM::PortStatus InPortBase::OutPortCorbaCdrConsumerMock::put ( const ::OpenRTM::CdrData &  data)
throw (CORBA::SystemException
)
inline

Definition at line 532 of file InPortBaseTests.cpp.

◆ put() [2/2]

RTC::OutPortConsumer::ReturnCode InPortBase::OutPortCorbaCdrConsumerMock::put ( const cdrMemoryStream &  data)
inline

Definition at line 552 of file InPortBaseTests.cpp.

◆ setBuffer()

void InPortBase::OutPortCorbaCdrConsumerMock::setBuffer ( RTC::BufferBase< cdrMemoryStream > *  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::OutPortConsumer.

Definition at line 521 of file InPortBaseTests.cpp.

◆ setListener()

void InPortBase::OutPortCorbaCdrConsumerMock::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::OutPortConsumer.

Definition at line 591 of file InPortBaseTests.cpp.

◆ setLogger()

void InPortBase::OutPortCorbaCdrConsumerMock::setLogger ( Logger logger)
inline

Definition at line 602 of file InPortBaseTests.cpp.

◆ subscribeInterface()

bool InPortBase::OutPortCorbaCdrConsumerMock::subscribeInterface ( const SDOPackage::NVList &  properties)
inlinevirtual

Subscribe the data receive notification.

Pure virtual function to subscribe the data receive notification based on specified property information.

Parameters
propertiesProperties for subscription
Returns
Subscription result (Successful:true, Failed:false)

Implements RTC::OutPortConsumer.

Definition at line 569 of file InPortBaseTests.cpp.

◆ unsubscribeInterface()

void InPortBase::OutPortCorbaCdrConsumerMock::unsubscribeInterface ( const SDOPackage::NVList &  properties)
inlinevirtual

Unsubscribe the data receive notification.

Pure virtual function to unsubscribe the data receive notification.

Parameters
propertiesProperties for unsubscription
Returns
Unsubscription result (Successful:true, Failed:false)

Implements RTC::OutPortConsumer.

Definition at line 579 of file InPortBaseTests.cpp.

Member Data Documentation

◆ m_logger

Logger* InPortBase::OutPortCorbaCdrConsumerMock::m_logger
private

Definition at line 607 of file InPortBaseTests.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:46