OpenRTM  1.0.0
Public Member Functions | Protected Attributes
RTC::OutPortConnector Class Reference

OutPortConnector base class. More...

#include <OutPortConnector.h>

Inheritance diagram for RTC::OutPortConnector:
RTC::ConnectorBase RTC::DataPortStatus RTC::OutPortPullConnector RTC::OutPortPushConnector

List of all members.

Public Member Functions

DATAPORTSTATUS_ENUM OutPortConnector (ConnectorInfo &info)
 Constructor.
virtual ~OutPortConnector ()
 Destructor.
const ConnectorInfoprofile ()
 Getting Profile.
const char * id ()
 Getting Connector ID.
const char * name ()
 Getting Connector name.
virtual ReturnCode disconnect ()=0
 Disconnect connection.
virtual CdrBufferBasegetBuffer ()=0
 Getting Buffer.
virtual ReturnCode write (const cdrMemoryStream &data)=0
 Destructor.
virtual void setEndian (const bool endian_type)
 Setting an endian type.
virtual bool isLittleEndian ()
 return it whether endian setting.
template<class DataType >
ReturnCode write (const DataType &data)
 The conversion template of the data type.

Protected Attributes

Logger rtclog
 Logger stream.
ConnectorInfo m_profile
 PortProfile of the Port.
bool m_littleEndian
 Connected Endian.
cdrMemoryStream m_cdr
 CDR stream.

Detailed Description

OutPortConnector base class.

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

Since:
1.0.0

Constructor & Destructor Documentation

Constructor.

Destructor.


Member Function Documentation

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

Disconnect connection.

This operation disconnect this connection

Implements RTC::ConnectorBase.

Implemented in RTC::OutPortPushConnector, and RTC::OutPortPullConnector.

virtual CdrBufferBase* RTC::OutPortConnector::getBuffer ( ) [pure virtual]

Getting Buffer.

This operation returns this connector's buffer

Implements RTC::ConnectorBase.

Implemented in RTC::OutPortPushConnector, and RTC::OutPortPullConnector.

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

Getting Connector ID.

This operation returns Connector ID

Implements RTC::ConnectorBase.

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

return it whether endian setting.

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

Referenced by write().

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

Getting Connector name.

This operation returns Connector name

Implements RTC::ConnectorBase.

Getting Profile.

This operation returns Connector Profile

Implements RTC::ConnectorBase.

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

Setting an endian type.

This operation set this connector's endian type

virtual ReturnCode RTC::OutPortConnector::write ( const cdrMemoryStream &  data) [pure virtual]

Destructor.

The write function to write data from OutPort to Buffer

Implemented in RTC::OutPortPushConnector, and RTC::OutPortPullConnector.

Referenced by write().

template<class DataType >
ReturnCode RTC::OutPortConnector::write ( const DataType &  data) [inline]

The conversion template of the data type.

This is convert it from Timed* into CdrStream.

References isLittleEndian(), m_cdr, RTC_TRACE, and write().


Member Data Documentation

cdrMemoryStream RTC::OutPortConnector::m_cdr [protected]

CDR stream.

Referenced by write().

Connected Endian.

PortProfile of the Port.

Logger stream.