InPortConnector base class. More...
#include <InPortConnector.h>
Public Member Functions | |
| virtual ReturnCode | disconnect ()=0 |
| Disconnect connection. | |
| virtual CdrBufferBase * | getBuffer () |
| Getting Buffer. | |
| virtual const char * | id () |
| Getting Connector ID. | |
| DATAPORTSTATUS_ENUM | InPortConnector (ConnectorInfo &info, CdrBufferBase *buffer) |
| Constructor. | |
| virtual bool | isLittleEndian () |
| Whether this connector's endian is little. | |
| virtual const char * | name () |
| Getting Connector name. | |
| virtual const ConnectorInfo & | profile () |
| Getting ConnectorInfo. | |
| virtual ReturnCode | read (cdrMemoryStream &data)=0 |
| Destructor. | |
| virtual void | setEndian (const bool endian_type) |
| Setting an endian type. | |
| virtual | ~InPortConnector () |
| Destructor. | |
Protected Attributes | |
| CdrBufferBase * | m_buffer |
| Connector's buffer. | |
| bool | m_littleEndian |
| Connected Endian. | |
| ConnectorInfo | m_profile |
| ConnectorInfo. | |
| Logger | rtclog |
| Logger stream. | |
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
| RTC::InPortConnector::InPortConnector | ( | ConnectorInfo & | info, |
| CdrBufferBase * | buffer | ||
| ) |
Constructor.
- Parameters:
-
info ConnectorInfo object which includes connection information buffer A pointer to the buffer of the connector
Definition at line 31 of file InPortConnector.cpp.
| RTC::InPortConnector::~InPortConnector | ( | ) | [virtual] |
Destructor.
Definition at line 45 of file InPortConnector.cpp.
Member Function Documentation
| 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.
| 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.
| 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.
| 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.
| 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.
| 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.
| virtual ReturnCode RTC::InPortConnector::read | ( | cdrMemoryStream & | 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, RTC::InPortPushConnector, and InPortConnector::InPortConnectorMock.
| void RTC::InPortConnector::setEndian | ( | const bool | endian_type | ) | [virtual] |
Setting an endian type.
This operation set this connector's endian type
- Parameters:
-
endian_type true: little, false: big
This operation set this connector's endian type
Definition at line 137 of file InPortConnector.cpp.
Member Data Documentation
CdrBufferBase* RTC::InPortConnector::m_buffer [protected] |
Connector's buffer.
Definition at line 257 of file InPortConnector.h.
bool RTC::InPortConnector::m_littleEndian [protected] |
Connected Endian.
Definition at line 265 of file InPortConnector.h.
ConnectorInfo RTC::InPortConnector::m_profile [protected] |
Definition at line 249 of file InPortConnector.h.
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: