OpenRTM-aist
1.1.2
|
InPortConnector base class. More...
#include <InPortConnector.h>
Public Member Functions | |
DATAPORTSTATUS_ENUM | InPortConnector (ConnectorInfo &info, CdrBufferBase *buffer) |
Constructor. More... | |
virtual | ~InPortConnector () |
Destructor. More... | |
virtual const ConnectorInfo & | profile () |
Getting ConnectorInfo. More... | |
virtual const char * | id () |
Getting Connector ID. More... | |
virtual const char * | name () |
Getting Connector name. More... | |
virtual ReturnCode | disconnect ()=0 |
Disconnect connection. More... | |
virtual CdrBufferBase * | getBuffer () |
Getting Buffer. More... | |
virtual ReturnCode | read (cdrMemoryStream &data)=0 |
Destructor. More... | |
virtual void | setEndian (const bool endian_type) |
Setting an endian type. More... | |
virtual bool | isLittleEndian () |
Whether this connector's endian is little. More... | |
![]() | |
virtual | ~ConnectorBase () |
Destructor. More... | |
virtual void | activate ()=0 |
Connector activation. More... | |
virtual void | deactivate ()=0 |
Connector deactivation. More... | |
Protected Attributes | |
Logger | rtclog |
Logger stream. More... | |
ConnectorInfo | m_profile |
ConnectorInfo. More... | |
CdrBufferBase * | m_buffer |
Connector's buffer. More... | |
bool | m_littleEndian |
Connected Endian. More... | |
Additional Inherited Members | |
![]() | |
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 const char * | toString (DataPortStatus::Enum status) |
Convert DataPortStatus into the string. More... | |
InPortConnector base class.
The base class to derive subclasses for InPort's Push/Pull Connectors
DATAPORTSTATUS_ENUM RTC::InPortConnector::InPortConnector | ( | ConnectorInfo & | info, |
CdrBufferBase * | buffer | ||
) |
Constructor.
info | ConnectorInfo object which includes connection information |
buffer | A pointer to the buffer of the connector |
|
virtual |
Destructor.
|
pure virtual |
Disconnect connection.
This operation disconnect this connection
Implements RTC::ConnectorBase.
Implemented in RTC::InPortPullConnector, and RTC::InPortPushConnector.
|
virtual |
Getting Buffer.
This operation returns this connector's buffer
Implements RTC::ConnectorBase.
|
virtual |
Getting Connector ID.
This operation returns Connector ID
Implements RTC::ConnectorBase.
|
virtual |
Whether this connector's endian is little.
This operation returns whether the connector's endian is little or not.
|
virtual |
Getting Connector name.
This operation returns Connector name
Implements RTC::ConnectorBase.
|
virtual |
Getting ConnectorInfo.
This operation returns ConnectorInfo
Implements RTC::ConnectorBase.
|
pure virtual |
Destructor.
The read function to read data from buffer to InPort
data | A reference to a variable to which data from this connector is stored. |
Implemented in RTC::InPortPullConnector, and RTC::InPortPushConnector.
|
virtual |
Setting an endian type.
This operation set this connector's endian type
endian_type | true: little, false: big |
|
protected |
Connector's buffer.
|
protected |
Connected Endian.
|
protected |