OpenRTM-aist  1.2.1
公開メンバ関数 | 限定公開変数類 | 全メンバ一覧
RTC::InPortConnector クラスabstract

InPortConnector 基底クラス [詳解]

#include <InPortConnector.h>

RTC::InPortConnector の継承関係図
Inheritance graph
[凡例]
RTC::InPortConnector 連携図
Collaboration graph
[凡例]

公開メンバ関数

DATAPORTSTATUS_ENUM InPortConnector (ConnectorInfo &info, ConnectorListeners &listeners, CdrBufferBase *buffer)
 コンストラクタ [詳解]
 
virtual ~InPortConnector ()
 デストラクタ [詳解]
 
virtual const ConnectorInfo & profile ()
 ConnectorInfo 取得 [詳解]
 
virtual const char * id ()
 Connector ID 取得 [詳解]
 
virtual const char * name ()
 Connector 名取得 [詳解]
 
virtual ReturnCode disconnect ()=0
 接続解除関数 [詳解]
 
virtual CdrBufferBase * getBuffer ()
 Buffer を取得する [詳解]
 
virtual ReturnCode read (cdrMemoryStream &data)=0
 read 関数 [詳解]
 
virtual void setEndian (const bool endian_type)
 endianタイプ設定 [詳解]
 
virtual bool isLittleEndian ()
 endian 設定を返す [詳解]
 
bool setOutPort (OutPortBase *directOutPort)
 データをダイレクトに書き込むためのOutPortのサーバントを設定する [詳解]
 
template<typename DataType >
bool getDirectData (DataType &data)
 
- 基底クラス RTC::ConnectorBase に属する継承公開メンバ関数
virtual ~ConnectorBase ()
 デストラクタ [詳解]
 
virtual void activate ()=0
 アクティブ化 [詳解]
 
virtual void deactivate ()=0
 非アクティブ化 [詳解]
 

限定公開変数類

Logger rtclog
 ロガーストリーム [詳解]
 
ConnectorInfo m_profile
 ConnectorInfo. [詳解]
 
ConnectorListeners & m_listeners
 ConnectorListenrs への参照 [詳解]
 
CdrBufferBase * m_buffer
 Connector が保持している Buffer. [詳解]
 
bool m_littleEndian
 接続エンディアン [詳解]
 
ConnectorListeners * m_outPortListeners
 OutPort 側の ConnectorListenrs への参照 [詳解]
 
PortBase * m_directOutPort
 同一プロセス上のピアOutPortのポインタ [詳解]
 

その他の継承メンバ

- 基底クラス RTC::DataPortStatus に属する継承公開型
enum  Enum {
  PORT_OK = 0, PORT_ERROR, BUFFER_ERROR, BUFFER_FULL,
  BUFFER_EMPTY, BUFFER_TIMEOUT, SEND_FULL, SEND_TIMEOUT,
  RECV_EMPTY, RECV_TIMEOUT, INVALID_ARGS, PRECONDITION_NOT_MET,
  CONNECTION_LOST, UNKNOWN_ERROR
}
 
- 基底クラス RTC::DataPortStatus に属する継承静的公開メンバ関数
static const char * toString (DataPortStatus::Enum status)
 DataPortStatus リターンコードを文字列に変換 [詳解]
 

詳解

InPortConnector 基底クラス

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

から
1.0.0

構築子と解体子

DATAPORTSTATUS_ENUM RTC::InPortConnector::InPortConnector ( ConnectorInfo &  info,
ConnectorListeners &  listeners,
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を実装しています。

template<typename DataType >
bool RTC::InPortConnector::getDirectData ( DataType &  data)
inline

参照先 RTC::ConnectorListeners::connectorData_, RTC::PortBase::getDirectPort(), RTC::DirectOutPortBase< DataType >::isEmpty(), m_directOutPort, m_listeners, m_outPortListeners, m_profile, RTC::ConnectorDataListenerHolder::notify(), RTC::ON_BUFFER_EMPTY, RTC::ON_BUFFER_READ, RTC::ON_RECEIVED, RTC::ON_SEND, RTC::ON_SENDER_EMPTY, RTC::DirectOutPortBase< DataType >::read(), RTC_PARANOID, RTC_TRACE (計16項目).

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_typetrue: little, false: big
bool RTC::InPortConnector::setOutPort ( OutPortBase *  directOutPort)

データをダイレクトに書き込むためのOutPortのサーバントを設定する

引数
directOutPortOutPortのサーバント
戻り値
True: 設定に成功 False: 既に設定済みのため失敗

メンバ詳解

CdrBufferBase* RTC::InPortConnector::m_buffer
protected

Connector が保持している Buffer.

PortBase* RTC::InPortConnector::m_directOutPort
protected

同一プロセス上のピアOutPortのポインタ

参照元 getDirectData().

ConnectorListeners& RTC::InPortConnector::m_listeners
protected

ConnectorListenrs への参照

参照元 getDirectData().

bool RTC::InPortConnector::m_littleEndian
protected

接続エンディアン

ConnectorListeners* RTC::InPortConnector::m_outPortListeners
protected

OutPort 側の ConnectorListenrs への参照

参照元 getDirectData().

ConnectorInfo RTC::InPortConnector::m_profile
protected

ConnectorInfo.

参照元 getDirectData(), RTC::InPortPushConnector::onBufferEmpty(), RTC::InPortPushConnector::onBufferRead(), RTC::InPortPushConnector::onBufferReadTimeout().

Logger RTC::InPortConnector::rtclog
protected

ロガーストリーム

このクラス詳解は次のファイルから抽出されました:
構築:   doxygen 1.8.11