クラス RTC::InPortConnector

InPortConnector 基底クラス. [詳細]

#include <InPortConnector.h>

RTC::InPortConnectorに対する継承グラフ
RTC::ConnectorBase RTC::DataPortStatus RTC::InPortPullConnector RTC::InPortPushConnector

すべてのメンバ一覧

Public メソッド

DATAPORTSTATUS_ENUM InPortConnector (ConnectorInfo &info, CdrBufferBase *buffer)
 コンストラクタ
virtual ~InPortConnector ()
 デストラクタ
virtual const ConnectorInfoprofile ()
 ConnectorInfo 取得.
virtual const char * id ()
 Connector ID 取得.
virtual const char * name ()
 Connector 名取得.
virtual ReturnCode disconnect ()=0
 接続解除関数
virtual CdrBufferBasegetBuffer ()
 Buffer を取得する.
virtual ReturnCode read (cdrMemoryStream &data)=0
 read 関数
virtual void setEndian (const bool endian_type)
 endianタイプ設定
virtual bool isLittleEndian ()
 endian 設定を返す

Protected 変数

Logger rtclog
 ロガーストリーム
ConnectorInfo m_profile
 ConnectorInfo.
CdrBufferBasem_buffer
 Connector が保持している Buffer.
bool m_littleEndian
 接続エンディアン

説明

InPortConnector 基底クラス.

InPort の Push/Pull 各種 Connector を派生させるための基底クラス。

から:
1.0.0

コンストラクタとデストラクタ

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

コンストラクタ

引数:
info 接続情報を含む ConnectorInfo オブジェクト
buffer このコネクタのバッファへのポインタ
virtual RTC::InPortConnector::~InPortConnector (  )  [virtual]

デストラクタ


関数

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

接続解除関数

Connector が保持している接続を解除する

戻り値:
ReturnCode

RTC::ConnectorBaseを実装しています。

RTC::InPortPullConnector, と RTC::InPortPushConnectorで実装されています。

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

Buffer を取得する.

Connector が保持している Buffer を返す

戻り値:
このコネクタが保持するバッファへのポインタ

RTC::ConnectorBaseを実装しています。

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

Connector ID 取得.

Connector ID を取得する

戻り値:
コネクタ ID 文字列へのポインタ

RTC::ConnectorBaseを実装しています。

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

endian 設定を返す

このコネクタに設定されたエンディアンが little endian かどうか。

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

Connector 名取得.

Connector 名を取得する

戻り値:
コネクタ名文字列へのポインタ

RTC::ConnectorBaseを実装しています。

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

ConnectorInfo 取得.

Connector ConnectorInfo を取得する

戻り値:
このコネクタが保持する ConnectorInfo オブジェクト

RTC::ConnectorBaseを実装しています。

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

read 関数

Buffer からデータを InPort へ read する関数

引数:
data このコネクタから読み出されるデータを格納する変数への参照
戻り値:
ReturnCode

RTC::InPortPullConnector, と RTC::InPortPushConnectorで実装されています。

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

endianタイプ設定

endianタイプを設定する

引数:
endian_type true: little, false: big

変数

Connector が保持している Buffer.

接続エンディアン

ロガーストリーム

OpenRTMに対してThu May 24 23:25:19 2012に生成されました。  doxygen 1.6.3