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

OutPortPullConnector クラス [詳解]

#include <OutPortPullConnector.h>

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

公開メンバ関数

DATAPORTSTATUS_ENUM OutPortPullConnector (ConnectorInfo info, OutPortProvider *provider, ConnectorListeners &listeners, CdrBufferBase *buffer=0)
 コンストラクタ [詳解]
 
virtual ~OutPortPullConnector ()
 デストラクタ [詳解]
 
virtual ReturnCode write (cdrMemoryStream &data)
 データの書き込み [詳解]
 
virtual ReturnCode disconnect ()
 接続解除 [詳解]
 
virtual CdrBufferBase * getBuffer ()
 Buffer を取得する [詳解]
 
virtual void activate ()
 アクティブ化 [詳解]
 
virtual void deactivate ()
 非アクティブ化 [詳解]
 
CdrBufferBase * createBuffer (ConnectorInfo &info)
 Bufferの生成 [詳解]
 
void onConnect ()
 接続確立時にコールバックを呼ぶ [詳解]
 
void onDisconnect ()
 接続切断時にコールバックを呼ぶ [詳解]
 
- 基底クラス RTC::OutPortConnector に属する継承公開メンバ関数
DATAPORTSTATUS_ENUM OutPortConnector (ConnectorInfo &info, ConnectorListeners &listeners)
 コンストラクタ [詳解]
 
virtual ~OutPortConnector ()
 デストラクタ [詳解]
 
const ConnectorInfo & profile ()
 Profile 取得 [詳解]
 
const char * id ()
 Connector ID 取得 [詳解]
 
const char * name ()
 Connector 名取得 [詳解]
 
virtual void setEndian (const bool endian_type)
 endianタイプ設定 [詳解]
 
virtual bool isLittleEndian ()
 endian 設定を返す [詳解]
 
template<class DataType >
ReturnCode write (DataType &data)
 データ型の変換テンプレート [詳解]
 
bool setInPort (InPortBase *directInPort)
 
virtual void setPullDirectMode ()
 ダイレクト接続モードに設定 [詳解]
 
virtual bool pullDirectMode ()
 ダイレクト接続モードかの判定 [詳解]
 
- 基底クラス RTC::ConnectorBase に属する継承公開メンバ関数
virtual ~ConnectorBase ()
 デストラクタ [詳解]
 

限定公開変数類

OutPortProvider * m_provider
 OutPortProvider へのポインタ [詳解]
 
ConnectorListeners & m_listeners
 ConnectorListenrs への参照 [詳解]
 
CdrBufferBase * m_buffer
 Buffer へのポインタ [詳解]
 
- 基底クラス RTC::OutPortConnector に属する継承限定公開変数類
Logger rtclog
 ロガーストリーム [詳解]
 
ConnectorInfo m_profile
 Port の PortProfile. [詳解]
 
bool m_littleEndian
 接続エンディアン [詳解]
 
cdrMemoryStream m_cdr
 cdrストリーム [詳解]
 
PortBase * m_directInPort
 同一プロセス上のピアInPortのポインタ [詳解]
 
ConnectorListeners & m_listeners
 ConnectorListenrs への参照 [詳解]
 
ConnectorListeners * m_inPortListeners
 InPort 側の ConnectorListenrs への参照 [詳解]
 
bool m_directMode
 

その他の継承メンバ

- 基底クラス 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 リターンコードを文字列に変換 [詳解]
 

詳解

OutPortPullConnector クラス

OutPort の pull 型データフローのための Connector クラス。このオブ ジェクトは、接続時に dataflow_type に pull が指定された場合、 OutPort によって生成・所有され、InPortPullConnector と対になって、 データポートの pull 型のデータフローを実現する。一つの接続に対して、 一つのデータストリームを提供する唯一の Connector が対応する。 Connector は 接続時に生成される UUID 形式の ID により区別される。

OutPortPullConnector は以下の三つのオブジェクトを所有し管理する。

OutPort に書き込まれたデータは OutPortPullConnector::write() に渡 され Buffer に書き込まれる。InPortPullConnector が OutPortPullConnector からデータを読み出すことで InPort にデータが 転送される。

から
1.0.0

構築子と解体子

DATAPORTSTATUS_ENUM RTC::OutPortPullConnector::OutPortPullConnector ( ConnectorInfo  info,
OutPortProvider *  provider,
ConnectorListeners &  listeners,
CdrBufferBase *  buffer = 0 
)

コンストラクタ

OutPortPullConnector のコンストラクタはオブジェクト生成時に下記 を引数にとる。ConnectorInfo は接続情報を含み、この情報に従いバッ ファ等を生成する。OutPort インターフェースのプロバイダオブジェク トへのポインタを取り、所有権を持つので、OutPortPullConnector は OutPortProvider の解体責任を持つ。各種イベントに対するコールバッ ク機構を提供する ConnectorListeners を持ち、適切なタイミングでコー ルバックを呼び出す。データバッファがもし OutPortBase から提供さ れる場合はそのポインタを取る。

引数
infoConnectorInfo
providerOutPortProvider
listenersConnectorListeners 型のリスナオブジェクトリスト
bufferCdrBufferBase 型のバッファ
virtual RTC::OutPortPullConnector::~OutPortPullConnector ( )
virtual

デストラクタ

disconnect() が呼ばれ、provider, buffer が解体・削除される。

関数詳解

virtual void RTC::OutPortPullConnector::activate ( )
inlinevirtual

アクティブ化

このコネクタをアクティブ化する

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

CdrBufferBase* RTC::OutPortPullConnector::createBuffer ( ConnectorInfo &  info)

Bufferの生成

参照元 deactivate().

virtual void RTC::OutPortPullConnector::deactivate ( )
inlinevirtual

非アクティブ化

このコネクタを非アクティブ化する

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

参照先 createBuffer(), onConnect(), onDisconnect().

virtual ReturnCode RTC::OutPortPullConnector::disconnect ( )
virtual

接続解除

consumer, publisher, buffer が解体・削除される。

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

virtual CdrBufferBase* RTC::OutPortPullConnector::getBuffer ( )
virtual

Buffer を取得する

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

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

void RTC::OutPortPullConnector::onConnect ( )

接続確立時にコールバックを呼ぶ

参照元 deactivate().

void RTC::OutPortPullConnector::onDisconnect ( )

接続切断時にコールバックを呼ぶ

参照元 deactivate().

virtual ReturnCode RTC::OutPortPullConnector::write ( cdrMemoryStream &  data)
virtual

データの書き込み

Publisherに対してデータを書き込み、これにより対応するInPortへ データが転送される。

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

メンバ詳解

CdrBufferBase* RTC::OutPortPullConnector::m_buffer
protected

Buffer へのポインタ

ConnectorListeners& RTC::OutPortPullConnector::m_listeners
protected

ConnectorListenrs への参照

OutPortProvider* RTC::OutPortPullConnector::m_provider
protected

OutPortProvider へのポインタ

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