Public Member Functions | List of all members
RTC::ConnectorBase Class Referenceabstract

Connector Base class. More...

#include <ConnectorBase.h>

Inheritance diagram for RTC::ConnectorBase:
Inheritance graph
[legend]

Public Member Functions

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

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

Connector Base class.

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

Since
1.0.0

Definition at line 156 of file ConnectorBase.h.

Constructor & Destructor Documentation

◆ ~ConnectorBase()

virtual RTC::ConnectorBase::~ConnectorBase ( )
inlinevirtual

Destructor.

Definition at line 191 of file ConnectorBase.h.

Member Function Documentation

◆ activate()

virtual void RTC::ConnectorBase::activate ( )
pure virtual

◆ deactivate()

virtual void RTC::ConnectorBase::deactivate ( )
pure virtual

◆ disconnect()

virtual ReturnCode RTC::ConnectorBase::disconnect ( )
pure virtual

◆ getBuffer()

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

Getting Buffer.

This operation returns this connector's buffer

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

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


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Mon Feb 28 2022 23:00:47