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

Public Member Functions

void init (coil::Properties &prop)
 Initializing configuration. More...
 
 InPortCorbaCdrProviderMock (void)
 
void publishInterfaceProfile (SDOPackage::NVList &properties)
 Publish InterfaceProfile information. More...
 
::OpenRTM::PortStatus put (const ::OpenRTM::CdrData &data) throw (CORBA::SystemException)
 
RTC::InPortConsumer::ReturnCode put (const cdrMemoryStream &data)
 
void setBuffer (RTC::BufferBase< cdrMemoryStream > *buffer)
 Setting outside buffer's pointer. More...
 
void setConnector (RTC::InPortConnector *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 ~InPortCorbaCdrProviderMock (void)
 
- Public Member Functions inherited from RTC::InPortProvider
DATAPORTSTATUS_ENUM InPortProvider ()
 Constructor. More...
 
virtual bool publishInterface (SDOPackage::NVList &properties)
 Publish interface information. More...
 
virtual ~InPortProvider (void)
 Destructor. More...
 

Private Attributes

Loggerm_logger
 
::OpenRTM::InPortCdr_var m_objref
 

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 363 of file InPortBaseTests.cpp.

Constructor & Destructor Documentation

InPortBase::InPortCorbaCdrProviderMock::InPortCorbaCdrProviderMock ( void  )
inline

Definition at line 370 of file InPortBaseTests.cpp.

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

Definition at line 390 of file InPortBaseTests.cpp.

Member Function Documentation

void InPortBase::InPortCorbaCdrProviderMock::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::InPortProvider.

Definition at line 420 of file InPortBaseTests.cpp.

void InPortBase::InPortCorbaCdrProviderMock::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::InPortProvider.

Definition at line 439 of file InPortBaseTests.cpp.

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

Definition at line 411 of file InPortBaseTests.cpp.

RTC::InPortConsumer::ReturnCode InPortBase::InPortCorbaCdrProviderMock::put ( const cdrMemoryStream &  data)
inline

Definition at line 431 of file InPortBaseTests.cpp.

void InPortBase::InPortCorbaCdrProviderMock::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::InPortProvider.

Definition at line 400 of file InPortBaseTests.cpp.

void InPortBase::InPortCorbaCdrProviderMock::setConnector ( RTC::InPortConnector 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::InPortProvider.

Definition at line 488 of file InPortBaseTests.cpp.

void InPortBase::InPortCorbaCdrProviderMock::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::InPortProvider.

Definition at line 482 of file InPortBaseTests.cpp.

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

Definition at line 477 of file InPortBaseTests.cpp.

bool InPortBase::InPortCorbaCdrProviderMock::subscribeInterface ( const SDOPackage::NVList &  properties)
inline

Definition at line 448 of file InPortBaseTests.cpp.

void InPortBase::InPortCorbaCdrProviderMock::unsubscribeInterface ( const SDOPackage::NVList &  properties)
inline

Definition at line 458 of file InPortBaseTests.cpp.

Member Data Documentation

Logger* InPortBase::InPortCorbaCdrProviderMock::m_logger
private

Definition at line 494 of file InPortBaseTests.cpp.

::OpenRTM::InPortCdr_var InPortBase::InPortCorbaCdrProviderMock::m_objref
private

Definition at line 495 of file InPortBaseTests.cpp.


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


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Thu Jun 6 2019 19:26:03