OpenRTM  1.0.0
Public Member Functions | Protected Attributes
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 ()
 Whether this connector's endian is little.

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

Constructor.

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

Destructor.


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, and RTC::InPortPushConnector.

Getting Buffer.

This operation returns this connector's buffer

Returns:
A pointer to the buffer owned by this connector

Implements RTC::ConnectorBase.

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

Getting Connector ID.

This operation returns Connector ID

Returns:
A pointer to the connector id string

Implements RTC::ConnectorBase.

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

Whether this connector's endian is little.

This operation returns whether the connector's endian is little or not.

Returns:
true: little endian, false: big endian
virtual const char* RTC::InPortConnector::name ( ) [virtual]

Getting Connector name.

This operation returns Connector name

Returns:
A pointer to the connector's name string

Implements RTC::ConnectorBase.

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

Getting ConnectorInfo.

This operation returns ConnectorInfo

Returns:
ConnectorInfo object which is owned by this connector

Implements RTC::ConnectorBase.

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, 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

Parameters:
endian_typetrue: little, false: big

Member Data Documentation

Connector's buffer.

Connected Endian.

Logger stream.