OutPortConnector base class. More...
#include <OutPortConnector.h>
Public Member Functions | |
| virtual ReturnCode | disconnect ()=0 |
| Disconnect connection. More... | |
| virtual CdrBufferBase * | getBuffer ()=0 |
| Getting Buffer. More... | |
| const char * | id () |
| Getting Connector ID. More... | |
| virtual bool | isLittleEndian () |
| return it whether endian setting. More... | |
| const char * | name () |
| Getting Connector name. More... | |
| DATAPORTSTATUS_ENUM | OutPortConnector (ConnectorInfo &info) |
| Constructor. More... | |
| const ConnectorInfo & | profile () |
| Getting Profile. More... | |
| virtual void | setEndian (const bool endian_type) |
| Setting an endian type. More... | |
| virtual ReturnCode | write (const cdrMemoryStream &data)=0 |
| Destructor. More... | |
| template<class DataType > | |
| ReturnCode | write (const DataType &data) |
| The conversion template of the data type. More... | |
| virtual | ~OutPortConnector () |
| 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 | |
| cdrMemoryStream | m_cdr |
| CDR stream. More... | |
| bool | m_littleEndian |
| Connected Endian. More... | |
| ConnectorInfo | m_profile |
| PortProfile of the Port. 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
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
◆ OutPortConnector()
| RTC::OutPortConnector::OutPortConnector | ( | ConnectorInfo & | info | ) |
Constructor.
Definition at line 31 of file OutPortConnector.cpp.
◆ ~OutPortConnector()
|
virtual |
Destructor.
Definition at line 43 of file OutPortConnector.cpp.
Member Function Documentation
◆ disconnect()
|
pure virtual |
Disconnect connection.
This operation disconnect this connection
Implements RTC::ConnectorBase.
Implemented in RTC::OutPortPushConnector, RTC::OutPortPullConnector, and OutPortConnector::OutPortConnectorMock.
◆ getBuffer()
|
pure virtual |
Getting Buffer.
This operation returns this connector's buffer
Implements RTC::ConnectorBase.
Implemented in RTC::OutPortPushConnector, RTC::OutPortPullConnector, and OutPortConnector::OutPortConnectorMock.
◆ id()
|
virtual |
Getting Connector ID.
This operation returns Connector ID
Implements RTC::ConnectorBase.
Definition at line 78 of file OutPortConnector.cpp.
◆ 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.
◆ name()
|
virtual |
Getting Connector name.
This operation returns Connector name
Implements RTC::ConnectorBase.
Definition at line 97 of file OutPortConnector.cpp.
◆ 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.
◆ setEndian()
|
virtual |
Setting an endian type.
This operation set this connector's endian type
Definition at line 116 of file OutPortConnector.cpp.
◆ write() [1/2]
|
pure virtual |
Destructor.
The write function to write data from OutPort to Buffer
Implemented in RTC::OutPortPushConnector, RTC::OutPortPullConnector, and OutPortConnector::OutPortConnectorMock.
◆ write() [2/2]
|
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
◆ m_cdr
|
protected |
CDR stream.
Definition at line 250 of file OutPortConnector.h.
◆ m_littleEndian
|
protected |
Connected Endian.
Definition at line 242 of file OutPortConnector.h.
◆ m_profile
|
protected |
PortProfile of the Port.
Definition at line 234 of file OutPortConnector.h.
◆ rtclog
|
protected |
Logger stream.
Definition at line 226 of file OutPortConnector.h.
The documentation for this class was generated from the following files: