OutPortBase::InPortCorbaCdrConsumerMock Class Reference

Inheritance diagram for OutPortBase::InPortCorbaCdrConsumerMock:

Public Member Functions
void	init (coil::Properties &prop)
	Initializing configuration. More...
	InPortCorbaCdrConsumerMock (void)
void	publishInterfaceProfile (SDOPackage::NVList &properties)
	Publish InterfaceProfile information. More...
RTC::InPortConsumer::ReturnCode	put (const cdrMemoryStream &data)
	Send data to the destination port. More...
void	setLogger (Logger *logger)
bool	subscribeFromIor (const SDOPackage::NVList &properties)
bool	subscribeFromRef (const SDOPackage::NVList &properties)
bool	subscribeInterface (const SDOPackage::NVList &properties)
	Subscribe the data send notification. More...
bool	unsubscribeFromIor (const SDOPackage::NVList &properties)
bool	unsubscribeFromRef (const SDOPackage::NVList &properties)
void	unsubscribeInterface (const SDOPackage::NVList &properties)
	Unsubscribe the data send notification. More...
virtual	~InPortCorbaCdrConsumerMock (void)
Public Member Functions inherited from RTC::InPortConsumer
virtual DATAPORTSTATUS_ENUM	~InPortConsumer (void)
	Destructor. More...
Public Member Functions inherited from RTC::CorbaConsumer< ::OpenRTM::InPortCdr >
typename ::OpenRTM::InPortCdr ::_ptr_type	_ptr ()
	Get Object reference narrowed as ObjectType. More...
	CorbaConsumer ()
	Consructor. More...
	CorbaConsumer (const CorbaConsumer &x)
	Copy constructor. More...
typename ::OpenRTM::InPortCdr ::_ptr_type	operator-> ()
	Get Object reference narrowed as ObjectType. More...
CorbaConsumer &	operator= (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...
CorbaConsumerBase &	operator= (const CorbaConsumerBase &x)
	Assignment operator. More...
void	swap (CorbaConsumerBase &x)
	swap function More...
virtual	~CorbaConsumerBase (void)
	Virtual destructor. More...

Private Attributes
Logger *	m_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::CorbaConsumer< ::OpenRTM::InPortCdr >
typename ::OpenRTM::InPortCdr ::_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 595 of file OutPortBaseTests.cpp.

Constructor & Destructor Documentation

InPortCorbaCdrConsumerMock()

OutPortBase::InPortCorbaCdrConsumerMock::InPortCorbaCdrConsumerMock ( void  )

inline

Definition at line 601 of file OutPortBaseTests.cpp.

~InPortCorbaCdrConsumerMock()

virtual OutPortBase::InPortCorbaCdrConsumerMock::~InPortCorbaCdrConsumerMock ( void  )

inlinevirtual

Definition at line 605 of file OutPortBaseTests.cpp.

Member Function Documentation

init()

void OutPortBase::InPortCorbaCdrConsumerMock::init ( coil::Properties &  prop )

inlinevirtual

Initializing configuration.

This operation would be called to configure this consumer in initialization.

Implements RTC::InPortConsumer.

Definition at line 612 of file OutPortBaseTests.cpp.

publishInterfaceProfile()

void OutPortBase::InPortCorbaCdrConsumerMock::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

properties

Properties to get InterfaceProfile information

Implements RTC::InPortConsumer.

Definition at line 631 of file OutPortBaseTests.cpp.

put()

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

inlinevirtual

Send data to the destination port.

Pure virtual function to send data to the destination port.

This function might the following return codes

• PORT_OK: Normal return
• PORT_ERROR: Error occurred in data transfer process
• SEND_FULL: Buffer full although OutPort tried to send data
• SEND_TIMEOUT: Timeout although OutPort tried to send data
• CONNECTION_LOST: Connection lost
• UNKNOWN_ERROR: Unknown error

Implements RTC::InPortConsumer.

Definition at line 623 of file OutPortBaseTests.cpp.

setLogger()

void OutPortBase::InPortCorbaCdrConsumerMock::setLogger ( Logger *  logger )

inline

Definition at line 679 of file OutPortBaseTests.cpp.

subscribeFromIor()

bool OutPortBase::InPortCorbaCdrConsumerMock::subscribeFromIor ( const SDOPackage::NVList &  properties )

inline

Definition at line 654 of file OutPortBaseTests.cpp.

subscribeFromRef()

bool OutPortBase::InPortCorbaCdrConsumerMock::subscribeFromRef ( const SDOPackage::NVList &  properties )

inline

Definition at line 659 of file OutPortBaseTests.cpp.

subscribeInterface()

bool OutPortBase::InPortCorbaCdrConsumerMock::subscribeInterface ( const SDOPackage::NVList &  properties )

inlinevirtual

Subscribe the data send notification.

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

Parameters

properties

Properties for reference when subscribing

Returns

Subscription result

Implements RTC::InPortConsumer.

Definition at line 640 of file OutPortBaseTests.cpp.

unsubscribeFromIor()

bool OutPortBase::InPortCorbaCdrConsumerMock::unsubscribeFromIor ( const SDOPackage::NVList &  properties )

inline

Definition at line 664 of file OutPortBaseTests.cpp.

unsubscribeFromRef()

bool OutPortBase::InPortCorbaCdrConsumerMock::unsubscribeFromRef ( const SDOPackage::NVList &  properties )

inline

Definition at line 669 of file OutPortBaseTests.cpp.

unsubscribeInterface()

void OutPortBase::InPortCorbaCdrConsumerMock::unsubscribeInterface ( const SDOPackage::NVList &  properties )

inlinevirtual

Unsubscribe the data send notification.

Pure virtual function to unsubscribe the data send notification.

Parameters

properties

Properties for reference when unsubscribing

Implements RTC::InPortConsumer.

Definition at line 650 of file OutPortBaseTests.cpp.

Member Data Documentation

m_logger

Logger* OutPortBase::InPortCorbaCdrConsumerMock::m_logger

private

Definition at line 684 of file OutPortBaseTests.cpp.

---

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

• OutPortBaseTests.cpp