#include <OutPortConnector.h>

Inheritance diagram for RTC::OutPortConnector:

[legend]

Collaboration diagram for RTC::OutPortConnector:

[legend]

Public Member Functions
	OutPortConnector (ConnectorInfo &info, ConnectorListenersBase *listeners)
	Constructor .

	~OutPortConnector () override
	Destructor .

const ConnectorInfo &	profile () override
	Getting Profile.

const char *	id () override
	Getting Connector ID.

const char *	name () override
	Getting Connector name.

DataPortStatus	disconnect () override=0
	Disconnect connection.

CdrBufferBase *	getBuffer () override=0
	Getting Buffer.

virtual DataPortStatus	write (ByteDataStreamBase *data)=0
	Destructor.

virtual void	setEndian (bool endian_type)
	Setting an endian type.

virtual bool	isLittleEndian ()
	return it whether endian setting.

template<class DataType >
DataPortStatus	write (DataType &data)
	The conversion template of the data type.

virtual BufferStatus	read (ByteData &data)

bool	setInPort (InPortBase *directInPort)

virtual void	setPullDirectMode ()

virtual bool	pullDirectMode ()

virtual void	unsubscribeInterface (const coil::Properties &prop)

Public Member Functions inherited from RTC::ConnectorBase
virtual	~ConnectorBase ()=default
	Destructor .

virtual void	activate ()=0
	Connector activation.

virtual void	deactivate ()=0
	Connector deactivation.

Protected Attributes
Logger	rtclog
	Logger streamf .

ConnectorInfo	m_profile
	PortProfile of the Port .

bool	m_littleEndian
	Connected Endian .

PortBase *	m_directInPort
	InProt pointer to the peer in the same process .

ConnectorListenersBase *	m_listeners
	A reference to a ConnectorListener .

ConnectorListenersBase *	m_inPortListeners
	A pointer to a InPort's ConnectorListener .

bool	m_directMode

std::string	m_marshaling_type

ByteDataStreamBase *	m_cdr

Detailed Description

OutPortConnector base class.

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

Since: 1.0.0

Constructor & Destructor Documentation

◆ OutPortConnector()

RTC::OutPortConnector::OutPortConnector	(	ConnectorInfo &	info,
		ConnectorListenersBase *	listeners )

Constructor .

◆ ~OutPortConnector()

RTC::OutPortConnector::~OutPortConnector ( )

override

Destructor .

Member Function Documentation

◆ disconnect()

DataPortStatus RTC::OutPortConnector::disconnect ( )

overridepure virtual

Disconnect connection.

This operation disconnect this connection

Implements RTC::ConnectorBase.

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

◆ getBuffer()

CdrBufferBase * RTC::OutPortConnector::getBuffer ( )

overridepure virtual

Getting Buffer.

This operation returns this connector's buffer

Implements RTC::ConnectorBase.

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

◆ id()

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

overridevirtual

Getting Connector ID.

This operation returns Connector ID

Implements RTC::ConnectorBase.

◆ isLittleEndian()

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

◆ name()

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

overridevirtual

Getting Connector name.

This operation returns Connector name

Implements RTC::ConnectorBase.

◆ profile()

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

overridevirtual

Getting Profile.

This operation returns Connector Profile

Implements RTC::ConnectorBase.

◆ pullDirectMode()

virtual bool RTC::OutPortConnector::pullDirectMode ( )

virtual

◆ read()

virtual BufferStatus RTC::OutPortConnector::read ( ByteData & data )

virtual

Reimplemented in RTC::OutPortPullConnector.

◆ setEndian()

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

virtual

Setting an endian type.

This operation set this connector's endian type

◆ setInPort()

bool RTC::OutPortConnector::setInPort ( InPortBase * directInPort )

◆ setPullDirectMode()

virtual void RTC::OutPortConnector::setPullDirectMode ( )

virtual

◆ unsubscribeInterface()

virtual void RTC::OutPortConnector::unsubscribeInterface ( const coil::Properties & prop )

virtual

Parameters

prop

Reimplemented in RTC::OutPortPushConnector.

◆ write() [1/2]

virtual DataPortStatus RTC::OutPortConnector::write ( ByteDataStreamBase * data )

pure virtual

Destructor.

The write function to write data from OutPort to Buffer

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

Referenced by write().

◆ write() [2/2]

template<class DataType >

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

inline

The conversion template of the data type.

This is convert it from Timed* into CdrStream.

References RTC::createSerializer(), RTC::PortBase::getDirectPort(), RTC::ByteDataStreamBase::isLittleEndian(), isLittleEndian(), RTC::DirectInPortBase< DataType >::isNew(), m_cdr, m_directInPort, m_inPortListeners, m_listeners, m_marshaling_type, m_profile, RTC::ConnectorListenersBase::notifyIn(), RTC::ConnectorListenersBase::notifyOut(), RTC::ON_BUFFER_OVERWRITE, RTC::ON_BUFFER_WRITE, RTC::ON_RECEIVED, RTC::ON_RECEIVER_FULL, RTC::PORT_ERROR, RTC::PORT_OK, RTC_ERROR, RTC_PARANOID, RTC_TRACE, RTC::ByteDataStream< DataType >::serialize(), RTC::DirectInPortBase< DataType >::write(), and write().

Member Data Documentation

◆ m_cdr

ByteDataStreamBase* RTC::OutPortConnector::m_cdr

protected

Referenced by write().

◆ m_directInPort

PortBase* RTC::OutPortConnector::m_directInPort

protected

InProt pointer to the peer in the same process .

Referenced by write().

◆ m_directMode

bool RTC::OutPortConnector::m_directMode

protected

◆ m_inPortListeners

ConnectorListenersBase* RTC::OutPortConnector::m_inPortListeners

protected

A pointer to a InPort's ConnectorListener .

Referenced by write().

◆ m_listeners

ConnectorListenersBase* RTC::OutPortConnector::m_listeners

protected

A reference to a ConnectorListener .

Referenced by write().

◆ m_littleEndian

bool RTC::OutPortConnector::m_littleEndian

protected

Connected Endian .

◆ m_marshaling_type

std::string RTC::OutPortConnector::m_marshaling_type

protected

Referenced by write().

◆ m_profile

ConnectorInfo RTC::OutPortConnector::m_profile

protected

PortProfile of the Port .

Referenced by write().

◆ rtclog

Logger RTC::OutPortConnector::rtclog

protected

Logger streamf .

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

OutPortConnector.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OutPortConnector()

◆ ~OutPortConnector()

Member Function Documentation

◆ disconnect()

◆ getBuffer()

◆ id()

◆ isLittleEndian()

◆ name()

◆ profile()

◆ pullDirectMode()

◆ read()

◆ setEndian()

◆ setInPort()

◆ setPullDirectMode()

◆ unsubscribeInterface()

◆ write() [1/2]

◆ write() [2/2]

Member Data Documentation

◆ m_cdr

◆ m_directInPort

◆ m_directMode

◆ m_inPortListeners

◆ m_listeners

◆ m_littleEndian

◆ m_marshaling_type

◆ m_profile

◆ rtclog