RTC::OutPortConnector Class Reference

OutPortConnector base class. More...

#include <OutPortConnector.h>

Inheritance diagram for RTC::OutPortConnector:

Collaboration diagram for RTC::OutPortConnector:

Public Member Functions
DATAPORTSTATUS_ENUM	OutPortConnector (ConnectorInfo &info, ConnectorListeners &listeners)
	Constructor. More...
virtual	~OutPortConnector ()
	Destructor. More...
const ConnectorInfo &	profile ()
	Getting Profile. More...
const char *	id ()
	Getting Connector ID. More...
const char *	name ()
	Getting Connector name. More...
virtual ReturnCode	disconnect ()=0
	Disconnect connection. More...
virtual CdrBufferBase *	getBuffer ()=0
	Getting Buffer. More...
virtual ReturnCode	write (cdrMemoryStream &data)=0
	Destructor. More...
virtual void	setEndian (const bool endian_type)
	Setting an endian type. More...
virtual bool	isLittleEndian ()
	return it whether endian setting. More...
template<class DataType >
ReturnCode	write (DataType &data)
	The conversion template of the data type. More...
bool	setInPort (InPortBase *directInPort)
virtual void	setPullDirectMode ()
virtual bool	pullDirectMode ()
Public Member Functions inherited from RTC::ConnectorBase
virtual	~ConnectorBase ()
	Destructor. More...
virtual void	activate ()=0
	Connector activation. More...
virtual void	deactivate ()=0
	Connector deactivation. More...

Protected Attributes
Logger	rtclog
	Logger streamf. More...
ConnectorInfo	m_profile
	PortProfile of the Port. More...
bool	m_littleEndian
	Connected Endian. More...
cdrMemoryStream	m_cdr
	CDR stream. More...
PortBase *	m_directInPort
	InProt pointer to the peer in the same process. More...
ConnectorListeners &	m_listeners
	A reference to a ConnectorListener. More...
ConnectorListeners *	m_inPortListeners
	A pointer to a InPort's ConnectorListener. More...
bool	m_directMode

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...

Detailed Description

OutPortConnector base class.

The base class to derive subclasses for OutPort's Push/Pull Connectors

Since

1.0.0

Constructor & Destructor Documentation

DATAPORTSTATUS_ENUM RTC::OutPortConnector::OutPortConnector	(	ConnectorInfo &	info,
		ConnectorListeners &	listeners
	)

Constructor.

virtual RTC::OutPortConnector::~OutPortConnector ( )

virtual

Destructor.

Member Function Documentation

virtual ReturnCode RTC::OutPortConnector::disconnect ( )

pure virtual

Disconnect connection.

This operation disconnect this connection

Implements RTC::ConnectorBase.

Implemented in RTC::OutPortPushConnector, and RTC::OutPortPullConnector.

virtual CdrBufferBase* RTC::OutPortConnector::getBuffer ( )

pure virtual

Getting Buffer.

This operation returns this connector's buffer

Implements RTC::ConnectorBase.

Implemented in RTC::OutPortPushConnector, and RTC::OutPortPullConnector.

const char* RTC::OutPortConnector::id ( )

virtual

Getting Connector ID.

This operation returns Connector ID

Implements RTC::ConnectorBase.

virtual bool RTC::OutPortConnector::isLittleEndian ( )

virtual

return it whether endian setting.

Returns

Return true in the case of "little", false in "big" than it.

Referenced by write().

const char* RTC::OutPortConnector::name ( )

virtual

Getting Connector name.

This operation returns Connector name

Implements RTC::ConnectorBase.

const ConnectorInfo& RTC::OutPortConnector::profile ( )

virtual

Getting Profile.

This operation returns Connector Profile

Implements RTC::ConnectorBase.

virtual bool RTC::OutPortConnector::pullDirectMode ( )

virtual

Referenced by write().

virtual void RTC::OutPortConnector::setEndian ( const bool  endian_type )

virtual

Setting an endian type.

This operation set this connector's endian type

bool RTC::OutPortConnector::setInPort

(

InPortBase *

directInPort

)

Referenced by write().

virtual void RTC::OutPortConnector::setPullDirectMode ( )

virtual

Referenced by write().

virtual ReturnCode RTC::OutPortConnector::write ( cdrMemoryStream &  data )

pure virtual

Destructor.

The write function to write data from OutPort to Buffer

Implemented in RTC::OutPortPushConnector, and RTC::OutPortPullConnector.

Referenced by write().

template<class DataType >

ReturnCode RTC::OutPortConnector::write ( DataType &  data )

inline

The conversion template of the data type.

This is convert it from Timed* into CdrStream.

References RTC::PortBase::getDirectPort(), isLittleEndian(), RTC::DirectInPortBase< DataType >::isNew(), m_cdr, m_directInPort, m_inPortListeners, m_listeners, m_profile, RTC::ON_BUFFER_OVERWRITE, RTC::ON_BUFFER_WRITE, RTC::ON_RECEIVED, RTC::ON_RECEIVER_FULL, RTC::DataPortStatus::PORT_OK, pullDirectMode(), RTC_PARANOID, RTC_TRACE, setInPort(), setPullDirectMode(), RTC::DirectInPortBase< DataType >::write(), and write().

Member Data Documentation

cdrMemoryStream RTC::OutPortConnector::m_cdr

protected

CDR stream.

Referenced by write().

PortBase* RTC::OutPortConnector::m_directInPort

protected

InProt pointer to the peer in the same process.

Referenced by write().

bool RTC::OutPortConnector::m_directMode

protected

ConnectorListeners* RTC::OutPortConnector::m_inPortListeners

protected

A pointer to a InPort's ConnectorListener.

Referenced by write().

ConnectorListeners& RTC::OutPortConnector::m_listeners

protected

A reference to a ConnectorListener.

Referenced by write().

bool RTC::OutPortConnector::m_littleEndian

protected

Connected Endian.

ConnectorInfo RTC::OutPortConnector::m_profile

protected

PortProfile of the Port.

Referenced by write().

Logger RTC::OutPortConnector::rtclog

protected

Logger streamf.

---

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

• OutPortConnector.h