Public Member Functions | Protected Attributes
RTC::InPortConnector Class Reference

InPortConnector base class. More...

#include <InPortConnector.h>

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

List of all members.

Public Member Functions

virtual ReturnCode disconnect ()=0
 Disconnect connection.
virtual CdrBufferBasegetBuffer ()
 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 ConnectorInfoprofile ()
 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

CdrBufferBasem_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

Constructor.

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

Definition at line 31 of file InPortConnector.cpp.

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.

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.

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.

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:
dataA 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_typetrue: little, false: big

This operation set this connector's endian type

Definition at line 137 of file InPortConnector.cpp.


Member Data Documentation

Connector's buffer.

Definition at line 257 of file InPortConnector.h.

Connected Endian.

Definition at line 265 of file InPortConnector.h.

ConnectorInfo.

Definition at line 249 of file InPortConnector.h.

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 Thu Aug 27 2015 14:16:41