OutPortConnector base class. More...
#include <OutPortConnector.h>
Public Member Functions | |
| virtual ReturnCode | disconnect ()=0 |
| Disconnect connection. | |
| virtual CdrBufferBase * | getBuffer ()=0 |
| Getting Buffer. | |
| const char * | id () |
| Getting Connector ID. | |
| virtual bool | isLittleEndian () |
| return it whether endian setting. | |
| const char * | name () |
| Getting Connector name. | |
| DATAPORTSTATUS_ENUM | OutPortConnector (ConnectorInfo &info) |
| Constructor. | |
| const ConnectorInfo & | profile () |
| Getting Profile. | |
| virtual void | setEndian (const bool endian_type) |
| Setting an endian type. | |
| virtual ReturnCode | write (const cdrMemoryStream &data)=0 |
| Destructor. | |
| template<class DataType > | |
| ReturnCode | write (const DataType &data) |
| The conversion template of the data type. | |
| virtual | ~OutPortConnector () |
| Destructor. | |
Protected Attributes | |
| cdrMemoryStream | m_cdr |
| CDR stream. | |
| bool | m_littleEndian |
| Connected Endian. | |
| ConnectorInfo | m_profile |
| PortProfile of the Port. | |
| Logger | rtclog |
| Logger stream. | |
Detailed Description
OutPortConnector base class.
The base class to derive subclasses for OutPort's Push/Pull Connectors
- Since:
- 1.0.0
Definition at line 48 of file OutPortConnector.h.
Constructor & Destructor Documentation
Constructor.
Definition at line 31 of file OutPortConnector.cpp.
| RTC::OutPortConnector::~OutPortConnector | ( | ) | [virtual] |
Destructor.
Definition at line 43 of file OutPortConnector.cpp.
Member Function Documentation
| virtual ReturnCode RTC::OutPortConnector::disconnect | ( | ) | [pure virtual] |
Disconnect connection.
This operation disconnect this connection
Implements RTC::ConnectorBase.
Implemented in RTC::OutPortPushConnector, RTC::OutPortPullConnector, and OutPortConnector::OutPortConnectorMock.
| virtual CdrBufferBase* RTC::OutPortConnector::getBuffer | ( | ) | [pure virtual] |
Getting Buffer.
This operation returns this connector's buffer
Implements RTC::ConnectorBase.
Implemented in RTC::OutPortPushConnector, RTC::OutPortPullConnector, and OutPortConnector::OutPortConnectorMock.
| const char * RTC::OutPortConnector::id | ( | ) | [virtual] |
Getting Connector ID.
This operation returns Connector ID
Implements RTC::ConnectorBase.
Definition at line 78 of file OutPortConnector.cpp.
| bool RTC::OutPortConnector::isLittleEndian | ( | ) | [virtual] |
return it whether endian setting.
return it whether endian setting is little
- Returns:
- Return true in the case of "little", false in "big" than it.
Definition at line 129 of file OutPortConnector.cpp.
| const char * RTC::OutPortConnector::name | ( | ) | [virtual] |
Getting Connector name.
This operation returns Connector name
Implements RTC::ConnectorBase.
Definition at line 97 of file OutPortConnector.cpp.
| const ConnectorInfo & RTC::OutPortConnector::profile | ( | ) | [virtual] |
Getting Profile.
Getting ConnectorInfo.
This operation returns Connector Profile
This operation returns ConnectorInfo
Implements RTC::ConnectorBase.
Definition at line 59 of file OutPortConnector.cpp.
| void RTC::OutPortConnector::setEndian | ( | const bool | endian_type | ) | [virtual] |
Setting an endian type.
This operation set this connector's endian type
Definition at line 116 of file OutPortConnector.cpp.
| virtual ReturnCode RTC::OutPortConnector::write | ( | const cdrMemoryStream & | data | ) | [pure virtual] |
Destructor.
The write function to write data from OutPort to Buffer
Implemented in RTC::OutPortPushConnector, RTC::OutPortPullConnector, and OutPortConnector::OutPortConnectorMock.
| ReturnCode RTC::OutPortConnector::write | ( | const DataType & | data | ) | [inline] |
The conversion template of the data type.
This is convert it from Timed* into CdrStream.
Definition at line 209 of file OutPortConnector.h.
Member Data Documentation
cdrMemoryStream RTC::OutPortConnector::m_cdr [protected] |
CDR stream.
Definition at line 250 of file OutPortConnector.h.
bool RTC::OutPortConnector::m_littleEndian [protected] |
Connected Endian.
Definition at line 242 of file OutPortConnector.h.
ConnectorInfo RTC::OutPortConnector::m_profile [protected] |
PortProfile of the Port.
Definition at line 234 of file OutPortConnector.h.
Logger RTC::OutPortConnector::rtclog [protected] |
Logger stream.
Definition at line 226 of file OutPortConnector.h.
The documentation for this class was generated from the following files: