OpenRTM-aist 2.0.2
|
#include <InPortPullConnector.h>
公開メンバ関数 | |
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 |
コンシューマのインターフェースの登録を取り消す | |
![]() | |
InPortConnector (ConnectorInfo &info, ConnectorListenersBase *listeners, CdrBufferBase *buffer) | |
コンストラクタ | |
~InPortConnector () override | |
デストラクタ | |
const ConnectorInfo & | profile () override |
ConnectorInfo 取得 | |
const char * | id () override |
Connector ID 取得 | |
const char * | name () override |
Connector 名取得 | |
CdrBufferBase * | getBuffer () 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) |
ダイレクト接続時に変数渡しでデータを取得する | |
![]() | |
virtual | ~ConnectorBase ()=default |
デストラクタ | |
限定公開メンバ関数 | |
void | onConnect () |
接続確立時にコールバックを呼ぶ | |
void | onDisconnect () |
接続切断時にコールバックを呼ぶ | |
静的限定公開メンバ関数 | |
static CdrBufferBase * | createBuffer (ConnectorInfo &info) |
Bufferの生成 | |
その他の継承メンバ | |
![]() | |
Logger | rtclog |
ロガーストリーム | |
ConnectorInfo | m_profile |
ConnectorInfo | |
ConnectorListenersBase * | m_listeners |
ConnectorListenrs への参照 | |
CdrBufferBase * | m_buffer |
Connector が保持している Buffer | |
bool | m_littleEndian |
接続エンディアン | |
ConnectorListenersBase * | m_outPortListeners |
OutPort 側の ConnectorListenrs への参照 | |
PortBase * | m_directOutPort |
同一プロセス上のピアOutPortのポインタ | |
std::string | m_marshaling_type |
シリアライザの名前 | |
ByteDataStreamBase * | m_cdr |
シリアライザへの参照 | |
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 のもつバッファにデータを書き込む。
RTC::InPortPullConnector::InPortPullConnector | ( | ConnectorInfo | info, |
OutPortConsumer * | consumer, | ||
ConnectorListenersBase * | listeners, | ||
CdrBufferBase * | buffer = nullptr ) |
コンストラクタ
InPortPullConnector のコンストラクタはオブジェクト生成時に下記 を引数にとる。ConnectorInfo は接続情報を含み、この情報に従いバッ ファ等を生成する。OutPort インターフェースのプロバイダオブジェク トへのポインタを取り、所有権を持つので、InPortPullConnector は OutPortConsumer の解体責任を持つ。各種イベントに対するコールバッ ク機構を提供する ConnectorListeners を持ち、適切なタイミングでコー ルバックを呼び出す。データバッファがもし InPortBase から提供さ れる場合はそのポインタを取る。
info | ConnectorInfo |
consumer | OutPortConsumer |
listeners | ConnectorListeners 型のリスナオブジェクトリスト |
buffer | CdrBufferBase 型のバッファ |
|
override |
デストラクタ
disconnect() が呼ばれ、consumer, publisher, buffer が解体・削除される。
|
inlineoverridevirtual |
|
staticprotected |
Bufferの生成
与えられた接続情報に基づきバッファを生成する。
info | 接続情報 |
|
inlineoverridevirtual |
|
overridevirtual |
|
protected |
接続確立時にコールバックを呼ぶ
|
protected |
接続切断時にコールバックを呼ぶ
|
overridevirtual |
read 関数
OutPortConsumer からデータを取得する。正常に読み出せた場合、戻り 値は PORT_OK となり、data に読み出されたデータが格納される。それ 以外の場合には、エラー値として BUFFER_EMPTY, TIMEOUT, PRECONDITION_NOT_MET, PORT_ERROR が返される。
RTC::InPortConnectorを実装しています。
|
overridevirtual |