Public Member Functions | Protected Attributes | List of all members
RTC::InPortConnector Class Referenceabstract

InPortConnector base class. More...

#include <InPortConnector.h>

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

Public Member Functions

virtual ReturnCode disconnect ()=0
 Disconnect connection. More...
 
virtual CdrBufferBasegetBuffer ()
 Getting Buffer. More...
 
virtual const char * id ()
 Getting Connector ID. More...
 
DATAPORTSTATUS_ENUM InPortConnector (ConnectorInfo &info, CdrBufferBase *buffer)
 Constructor. More...
 
virtual bool isLittleEndian ()
 Whether this connector's endian is little. More...
 
virtual const char * name ()
 Getting Connector name. More...
 
virtual const ConnectorInfoprofile ()
 Getting ConnectorInfo. More...
 
virtual ReturnCode read (cdrMemoryStream &data)=0
 Destructor. More...
 
virtual void setEndian (const bool endian_type)
 Setting an endian type. More...
 
virtual ~InPortConnector ()
 Destructor. More...
 
- Public Member Functions inherited from RTC::ConnectorBase
virtual void activate ()=0
 Connector activation. More...
 
virtual void deactivate ()=0
 Connector deactivation. More...
 
virtual ~ConnectorBase ()
 Destructor. More...
 

Protected Attributes

CdrBufferBasem_buffer
 Connector's buffer. More...
 
bool m_littleEndian
 Connected Endian. More...
 
ConnectorInfo m_profile
 ConnectorInfo. More...
 
Logger rtclog
 Logger stream. 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

InPortConnector base class.

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

Since
1.0.0

Definition at line 46 of file InPortConnector.h.

Constructor & Destructor Documentation

◆ InPortConnector()

RTC::InPortConnector::InPortConnector ( ConnectorInfo info,
CdrBufferBase buffer 
)

Constructor.

Parameters
infoConnectorInfo object which includes connection information
bufferA pointer to the buffer of the connector

Definition at line 31 of file InPortConnector.cpp.

◆ ~InPortConnector()

RTC::InPortConnector::~InPortConnector ( )
virtual

Destructor.

Definition at line 45 of file InPortConnector.cpp.

Member Function Documentation

◆ disconnect()

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

Disconnect connection.

This operation disconnect this connection

Returns
ReturnCode

Implements RTC::ConnectorBase.

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

◆ getBuffer()

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

Getting Buffer.

This operation returns this connector's buffer

Returns
A pointer to the buffer owned by this connector

This operation returns this connector's buffer

Implements RTC::ConnectorBase.

Definition at line 119 of file InPortConnector.cpp.

◆ id()

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

Getting Connector ID.

This operation returns Connector ID

Returns
A pointer to the connector id string

This operation returns Connector ID

Implements RTC::ConnectorBase.

Definition at line 81 of file InPortConnector.cpp.

◆ isLittleEndian()

bool RTC::InPortConnector::isLittleEndian ( )
virtual

Whether this connector's endian is little.

return it whether endian setting is little

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

Returns
true: little endian, false: big endian

Definition at line 150 of file InPortConnector.cpp.

◆ name()

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

Getting Connector name.

This operation returns Connector name

Returns
A pointer to the connector's name string

This operation returns Connector name

Implements RTC::ConnectorBase.

Definition at line 100 of file InPortConnector.cpp.

◆ profile()

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

Getting ConnectorInfo.

This operation returns ConnectorInfo

Returns
ConnectorInfo object which is owned by this connector

This operation returns Connector ConnectorInfo

Implements RTC::ConnectorBase.

Definition at line 62 of file InPortConnector.cpp.

◆ read()

virtual ReturnCode RTC::InPortConnector::read ( cdrMemoryStream &  data)
pure virtual

Destructor.

The read function to read data from buffer to InPort

Parameters
dataA reference to a variable to which data from this connector is stored.
Returns
ReturnCode

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

◆ setEndian()

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

Setting an endian type.

This operation set this connector's endian type

Parameters
endian_typetrue: little, false: big

This operation set this connector's endian type

Definition at line 137 of file InPortConnector.cpp.

Member Data Documentation

◆ m_buffer

CdrBufferBase* RTC::InPortConnector::m_buffer
protected

Connector's buffer.

Definition at line 257 of file InPortConnector.h.

◆ m_littleEndian

bool RTC::InPortConnector::m_littleEndian
protected

Connected Endian.

Definition at line 265 of file InPortConnector.h.

◆ m_profile

ConnectorInfo RTC::InPortConnector::m_profile
protected

ConnectorInfo.

Definition at line 249 of file InPortConnector.h.

◆ rtclog

Logger RTC::InPortConnector::rtclog
protected

Logger stream.

Definition at line 241 of file InPortConnector.h.


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


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