OpenRTM-aist 2.0.2
Loading...
Searching...
No Matches
RTC::ConnectorBase Class Referenceabstract

Connector Base class. More...

#include <ConnectorBase.h>

Inheritance diagram for RTC::ConnectorBase:

Public Member Functions

virtual ~ConnectorBase ()=default
 Destructor .
 
virtual const ConnectorInfoprofile ()=0
 Getting Profile.
 
virtual const char * id ()=0
 Getting Connector ID.
 
virtual const char * name ()=0
 Getting Connector name.
 
virtual DataPortStatus disconnect ()=0
 Disconnect connection.
 
virtual CdrBufferBasegetBuffer ()=0
 Getting Buffer.
 
virtual void activate ()=0
 Connector activation.
 
virtual void deactivate ()=0
 Connector deactivation.
 

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::InPortConnector, RTC::InPortPullConnector, RTC::InPortPushConnector, RTC::OutPortConnector, RTC::OutPortPullConnector, and RTC::OutPortPushConnector.

◆ getBuffer()

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

Getting Buffer.

This operation returns this connector's buffer

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

◆ 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: