RTC::InPortConnector Class Reference

InPortConnector base class. More...

#include <InPortConnector.h>

Inheritance diagram for RTC::InPortConnector:

RTC::ConnectorBase RTC::DataPortStatus RTC::InPortPullConnector RTC::InPortPushConnector

List of all members.

Public Member Functions

DATAPORTSTATUS_ENUM InPortConnector (ConnectorInfo &info, CdrBufferBase *buffer)
 Constructor.
virtual ~InPortConnector ()
 Destructor.
virtual const ConnectorInfoprofile ()
 Getting ConnectorInfo.
virtual const char * id ()
 Getting Connector ID.
virtual const char * name ()
 Getting Connector name.
virtual ReturnCode disconnect ()=0
 Disconnect connection.
virtual CdrBufferBasegetBuffer ()
 Getting Buffer.
virtual ReturnCode read (cdrMemoryStream &data)=0
 Destructor.
virtual void setEndian (const bool endian_type)
 Setting an endian type.
virtual bool isLittleEndian ()
 return it whether endian setting.

Protected Attributes

Logger rtclog
 Logger stream.
ConnectorInfo m_profile
 ConnectorInfo.
CdrBufferBasem_buffer
 Connector's buffer.
bool m_littleEndian
 Connected Endian.


Detailed Description

InPortConnector base class.

The base class to derive subclasses for InPort's Push/Pull Connectors

Since:
1.0.0

Constructor & Destructor Documentation

DATAPORTSTATUS_ENUM RTC::InPortConnector::InPortConnector ( ConnectorInfo info,
CdrBufferBase buffer 
)

Constructor.

virtual RTC::InPortConnector::~InPortConnector (  )  [virtual]

Destructor.


Member Function Documentation

virtual const ConnectorInfo& RTC::InPortConnector::profile (  )  [virtual]

Getting ConnectorInfo.

This operation returns ConnectorInfo

Implements RTC::ConnectorBase.

virtual const char* RTC::InPortConnector::id (  )  [virtual]

Getting Connector ID.

This operation returns Connector ID

Implements RTC::ConnectorBase.

virtual const char* RTC::InPortConnector::name (  )  [virtual]

Getting Connector name.

This operation returns Connector name

Implements RTC::ConnectorBase.

virtual ReturnCode RTC::InPortConnector::disconnect (  )  [pure virtual]

Disconnect connection.

This operation disconnect this connection

Implements RTC::ConnectorBase.

Implemented in RTC::InPortPullConnector, and RTC::InPortPushConnector.

virtual CdrBufferBase* RTC::InPortConnector::getBuffer (  )  [virtual]

Getting Buffer.

This operation returns this connector's buffer

Implements RTC::ConnectorBase.

virtual ReturnCode RTC::InPortConnector::read ( cdrMemoryStream &  data  )  [pure virtual]

Destructor.

The read function to read data from buffer to InPort

Implemented in RTC::InPortPullConnector, and RTC::InPortPushConnector.

virtual void RTC::InPortConnector::setEndian ( const bool  endian_type  )  [virtual]

Setting an endian type.

This operation set this connector's endian type

virtual bool RTC::InPortConnector::isLittleEndian (  )  [virtual]

return it whether endian setting.

Returns:
Return true in the case of "little", false in "big" than it.


Member Data Documentation

Logger stream.

Connector's buffer.

Connected Endian.


Generated on Thu Jan 28 13:25:36 2010 for OpenRTM by  doxygen 1.5.5