OpenRTM-aist 2.1.0
読み取り中…
検索中…
一致する文字列を見つけられません
公開メンバ関数 | 限定公開メンバ関数 | 静的限定公開メンバ関数 | 全メンバ一覧
RTC::InPortPullConnector クラス

InPortPullConnector クラス [詳解]

#include <InPortPullConnector.h>

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

公開メンバ関数

 InPortPullConnector (ConnectorInfo info, OutPortConsumer *consumer, ConnectorListenersBase *listeners, CdrBufferBase *buffer=nullptr)
 コンストラクタ
 
 ~InPortPullConnector () override
 デストラクタ
 
DataPortStatus read (ByteDataStreamBase *data) override
 read 関数
 
DataPortStatus disconnect () override
 接続解除関数
 
void activate () override
 アクティブ化
 
void deactivate () override
 非アクティブ化
 
void unsubscribeInterface (const coil::Properties &prop) override
 コンシューマのインターフェースの登録を取り消す
 
- 基底クラス RTC::InPortConnector に属する継承公開メンバ関数
 InPortConnector (ConnectorInfo &info, ConnectorListenersBase *listeners, CdrBufferBase *buffer)
 コンストラクタ
 
 ~InPortConnector () override
 デストラクタ
 
const ConnectorInfoprofile () override
 ConnectorInfo 取得
 
const char * id () override
 Connector ID 取得
 
const char * name () override
 Connector 名取得
 
CdrBufferBasegetBuffer () override
 Buffer を取得する
 
template<class DataType >
DataPortStatus read (DataType &data)
 データ型の変換テンプレート
 
virtual void setEndian (bool endian_type)
 endianタイプ設定
 
virtual bool isLittleEndian ()
 endian 設定を返す
 
virtual BufferStatus write (ByteData &cdr)
 
bool setOutPort (OutPortBase *directOutPort)
 データをダイレクトに書き込むためのOutPortのサーバントを設定する
 
template<typename DataType >
bool getDirectData (DataType &data)
 ダイレクト接続時に変数渡しでデータを取得する
 
- 基底クラス RTC::ConnectorBase に属する継承公開メンバ関数
virtual ~ConnectorBase ()=default
 デストラクタ
 

限定公開メンバ関数

void onConnect ()
 接続確立時にコールバックを呼ぶ
 
void onDisconnect ()
 接続切断時にコールバックを呼ぶ
 

静的限定公開メンバ関数

static CdrBufferBasecreateBuffer (ConnectorInfo &info)
 Bufferの生成
 

その他の継承メンバ

- 基底クラス RTC::InPortConnector に属する継承限定公開変数類
Logger rtclog
 ロガーストリーム
 
ConnectorInfo m_profile
 ConnectorInfo
 
ConnectorListenersBasem_listeners
 ConnectorListenrs への参照
 
CdrBufferBasem_buffer
 Connector が保持している Buffer
 
bool m_littleEndian
 接続エンディアン
 
ConnectorListenersBasem_outPortListeners
 OutPort 側の ConnectorListenrs への参照
 
PortBasem_directOutPort
 同一プロセス上のピアOutPortのポインタ
 
std::string m_marshaling_type
 シリアライザの名前
 
ByteDataStreamBasem_cdr
 シリアライザへの参照
 

詳解

InPortPullConnector クラス

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

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

OutPort に書き込まれたデータは OutPortPullConnector::write() に渡 され Buffer に書き込まれる。InPort::read(), InPortPullConnector::read() は結果として、OutPortConsumer::get() を呼び出し、OutPortPullConnector の持つバッファからデータを読み出 し、InPortPullConnector のもつバッファにデータを書き込む。

から
1.0.0

構築子と解体子

◆ InPortPullConnector()

RTC::InPortPullConnector::InPortPullConnector ( ConnectorInfo  info,
OutPortConsumer consumer,
ConnectorListenersBase listeners,
CdrBufferBase buffer = nullptr 
)

コンストラクタ

◆ ~InPortPullConnector()

RTC::InPortPullConnector::~InPortPullConnector ( )
override

デストラクタ

関数詳解

◆ activate()

void RTC::InPortPullConnector::activate ( )
inlineoverridevirtual

アクティブ化

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

◆ createBuffer()

static CdrBufferBase * RTC::InPortPullConnector::createBuffer ( ConnectorInfo info)
staticprotected

Bufferの生成

◆ deactivate()

void RTC::InPortPullConnector::deactivate ( )
inlineoverridevirtual

非アクティブ化

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

◆ disconnect()

DataPortStatus RTC::InPortPullConnector::disconnect ( )
overridevirtual

接続解除関数

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

◆ onConnect()

void RTC::InPortPullConnector::onConnect ( )
protected

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

◆ onDisconnect()

void RTC::InPortPullConnector::onDisconnect ( )
protected

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

◆ read()

DataPortStatus RTC::InPortPullConnector::read ( ByteDataStreamBase data)
overridevirtual

read 関数

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

◆ unsubscribeInterface()

void RTC::InPortPullConnector::unsubscribeInterface ( const coil::Properties &  prop)
overridevirtual

コンシューマのインターフェースの登録を取り消す

RTC::InPortConnectorを再実装しています。


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