RTC::ConnectorBase Class Reference

Connector Base class. More...

#include <ConnectorBase.h>

Inheritance diagram for RTC::ConnectorBase:

Public Member Functions
virtual	~ConnectorBase ()=default
	Destructor . More...
virtual const ConnectorInfo &	profile ()=0
	Getting Profile. More...
virtual const char *	id ()=0
	Getting Connector ID. More...
virtual const char *	name ()=0
	Getting Connector name. More...
virtual DataPortStatus	disconnect ()=0
	Disconnect connection. More...
virtual CdrBufferBase *	getBuffer ()=0
	Getting Buffer. More...
virtual void	activate ()=0
	Connector activation. More...
virtual void	deactivate ()=0
	Connector deactivation. More...

Detailed Description

Connector Base class.

The base class to derive subclasses for InPort/OutPort, Push/Pull Connectors

Since

1.0.0

Constructor & Destructor Documentation

~ConnectorBase()

virtual RTC::ConnectorBase::~ConnectorBase ( )

virtualdefault

Destructor .

Member Function Documentation

activate()

virtual void RTC::ConnectorBase::activate ( )

pure virtual

Connector activation.

This operation activates this connector

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

deactivate()

virtual void RTC::ConnectorBase::deactivate ( )

pure virtual

Connector deactivation.

This operation deactivates this connector

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

disconnect()

virtual DataPortStatus RTC::ConnectorBase::disconnect ( )

pure virtual

Disconnect connection.

This operation disconnect this connection

Implemented in RTC::InPortPullConnector, RTC::InPortPushConnector, RTC::OutPortPullConnector, RTC::OutPortPushConnector, RTC::InPortConnector, and RTC::OutPortConnector.

getBuffer()

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

pure virtual

Getting Buffer.

This operation returns this connector's buffer

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

id()

virtual const char * RTC::ConnectorBase::id ( )

pure virtual

Getting Connector ID.

This operation returns Connector ID

Implemented in RTC::InPortConnector, and RTC::OutPortConnector.

name()

virtual const char * RTC::ConnectorBase::name ( )

pure virtual

Getting Connector name.

This operation returns Connector name

Implemented in RTC::InPortConnector, and RTC::OutPortConnector.

profile()

virtual const ConnectorInfo & RTC::ConnectorBase::profile ( )

pure virtual

Getting Profile.

This operation returns Connector Profile

Implemented in RTC::InPortConnector, and RTC::OutPortConnector.

---

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

• ConnectorBase.h