#include <InPortConnector.h>

Inheritance diagram for RTC::InPortConnector:

[legend]

Collaboration diagram for RTC::InPortConnector:

[legend]

Public Member Functions
	InPortConnector (ConnectorInfo &info, ConnectorListenersBase listeners, CdrBufferBase buffer)
	Constructor.

	~InPortConnector () override
	Destructor .

const ConnectorInfo &	profile () override
	Getting ConnectorInfo.

const char *	id () override
	Getting Connector ID.

const char *	name () override
	Getting Connector name.

DataPortStatus	disconnect () override=0
	Disconnect connection.

CdrBufferBase *	getBuffer () override
	Getting Buffer.

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

template<class DataType >
DataPortStatus	read (DataType &data)

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

virtual bool	isLittleEndian ()
	Whether this connector's endian is little.

virtual BufferStatus	write (ByteData &cdr)

bool	setOutPort (OutPortBase *directOutPort)

template<typename DataType >
bool	getDirectData (DataType &data)

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

ConnectorInfo	m_profile
	ConnectorInfo .

ConnectorListenersBase *	m_listeners
	A reference to a ConnectorListener .

CdrBufferBase *	m_buffer
	Connector's buffer .

bool	m_littleEndian
	Connected Endian .

ConnectorListenersBase *	m_outPortListeners
	A pointer to a OutPort's ConnectorListener .

PortBase *	m_directOutPort
	OutProt pointer to the peer in the same process .

std::string	m_marshaling_type

ByteDataStreamBase *	m_cdr

Detailed Description

InPortConnector base class.

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

Since: 1.0.0

Constructor & Destructor Documentation

◆ InPortConnector()

RTC::InPortConnector::InPortConnector	(	ConnectorInfo &	info,
		ConnectorListenersBase *	listeners,
		CdrBufferBase *	buffer )

Constructor.

Parameters

info	ConnectorInfo object which includes connection information
buffer	A pointer to the buffer of the connector

◆ ~InPortConnector()

RTC::InPortConnector::~InPortConnector ( )

override

Destructor .

Member Function Documentation

◆ disconnect()

DataPortStatus RTC::InPortConnector::disconnect ( )

overridepure virtual

Disconnect connection.

This operation disconnect this connection

Returns: ReturnCode

Implements RTC::ConnectorBase.

Implemented in RTC::InPortPullConnector, and RTC::InPortPushConnector.

◆ getBuffer()

CdrBufferBase * RTC::InPortConnector::getBuffer ( )

overridevirtual

Getting Buffer.

This operation returns this connector's buffer

Returns: A pointer to the buffer owned by this connector

Implements RTC::ConnectorBase.

◆ getDirectData()

template<typename DataType >

bool RTC::InPortConnector::getDirectData ( DataType & data )

inline

Parameters

data

Returns

References RTC::PortBase::getDirectPort(), RTC::DirectOutPortBase< DataType >::isEmpty(), m_directOutPort, m_listeners, m_outPortListeners, m_profile, RTC::ConnectorListenersBase::notify(), RTC::ConnectorListenersBase::notifyIn(), RTC::ConnectorListenersBase::notifyOut(), RTC::ON_BUFFER_EMPTY, RTC::ON_BUFFER_READ, RTC::ON_RECEIVED, RTC::ON_SEND, RTC::ON_SENDER_EMPTY, RTC::DirectOutPortBase< DataType >::read(), RTC_PARANOID, and RTC_TRACE.

Referenced by RTC::InPort< DataType >::read().

◆ id()

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

overridevirtual

Getting Connector ID.

This operation returns Connector ID

Returns: A pointer to the connector id string

Implements RTC::ConnectorBase.

◆ isLittleEndian()

virtual bool RTC::InPortConnector::isLittleEndian ( )

virtual

Whether this connector's endian is little.

This operation returns whether the connector's endian is little or not.

Returns: true: little endian, false: big endian

Referenced by read().

◆ name()

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

overridevirtual

Getting Connector name.

This operation returns Connector name

Returns: A pointer to the connector's name string

Implements RTC::ConnectorBase.

◆ profile()

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

overridevirtual

Getting ConnectorInfo.

This operation returns ConnectorInfo

Returns: ConnectorInfo object which is owned by this connector

Implements RTC::ConnectorBase.

◆ read() [1/2]

virtual DataPortStatus RTC::InPortConnector::read ( ByteDataStreamBase * data )

pure virtual

Destructor.

The read function to read data from buffer to InPort

Parameters

data	A reference to a variable to which data from this connector is stored.

Returns: ReturnCode

Implemented in RTC::InPortPullConnector, and RTC::InPortPushConnector.

Referenced by RTC::InPort< DataType >::read(), and read().

◆ read() [2/2]

template<class DataType >

DataPortStatus RTC::InPortConnector::read ( DataType & data )

inline

Parameters

data

Returns

References RTC::createSerializer(), RTC::ByteDataStream< DataType >::deserialize(), RTC::ByteDataStreamBase::isLittleEndian(), isLittleEndian(), m_cdr, m_marshaling_type, RTC::PORT_ERROR, RTC::PORT_OK, read(), and RTC_ERROR.

◆ setEndian()

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

virtual

Setting an endian type.

This operation set this connector's endian type

Parameters

endian_type true: little, false: big

◆ setOutPort()

bool RTC::InPortConnector::setOutPort ( OutPortBase * directOutPort )

Parameters

directOutPort

Returns: true: little endian, false: big endian

◆ unsubscribeInterface()

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

virtual

Parameters

prop

Reimplemented in RTC::InPortPullConnector.

◆ write()

virtual BufferStatus RTC::InPortConnector::write ( ByteData & cdr )

virtual

Reimplemented in RTC::InPortPushConnector.

Member Data Documentation

◆ m_buffer

CdrBufferBase* RTC::InPortConnector::m_buffer

protected

Connector's buffer .

◆ m_cdr

ByteDataStreamBase* RTC::InPortConnector::m_cdr

protected

Referenced by read().

◆ m_directOutPort

PortBase* RTC::InPortConnector::m_directOutPort

protected

OutProt pointer to the peer in the same process .

Referenced by getDirectData().

◆ m_listeners

ConnectorListenersBase* RTC::InPortConnector::m_listeners

protected

A reference to a ConnectorListener .

Referenced by getDirectData().

◆ m_littleEndian

bool RTC::InPortConnector::m_littleEndian

protected

Connected Endian .

◆ m_marshaling_type

std::string RTC::InPortConnector::m_marshaling_type

protected

Referenced by read().

◆ m_outPortListeners

ConnectorListenersBase* RTC::InPortConnector::m_outPortListeners

protected

A pointer to a OutPort's ConnectorListener .

Referenced by getDirectData().

◆ m_profile

ConnectorInfo RTC::InPortConnector::m_profile

protected

ConnectorInfo .

Referenced by getDirectData(), RTC::InPortPushConnector::onBufferEmpty(), RTC::InPortPushConnector::onBufferRead(), and RTC::InPortPushConnector::onBufferReadTimeout().

◆ rtclog

Logger RTC::InPortConnector::rtclog

protected

Logger stream .

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

InPortConnector.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ InPortConnector()

◆ ~InPortConnector()

Member Function Documentation

◆ disconnect()

◆ getBuffer()

◆ getDirectData()

◆ id()

◆ isLittleEndian()

◆ name()

◆ profile()

◆ read() [1/2]

◆ read() [2/2]

◆ setEndian()

◆ setOutPort()

◆ unsubscribeInterface()

◆ write()

Member Data Documentation

◆ m_buffer

◆ m_cdr

◆ m_directOutPort

◆ m_listeners

◆ m_littleEndian

◆ m_marshaling_type

◆ m_outPortListeners

◆ m_profile

◆ rtclog