#include <InPortPullConnector.h>

RTC::InPortPullConnector の継承関係図

[凡例]

RTC::InPortPullConnector 連携図

[凡例]

公開メンバ関数
	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 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)
	ダイレクト接続時に変数渡しでデータを取得する

基底クラス RTC::ConnectorBase に属する継承公開メンバ関数
virtual	~ConnectorBase ()=default
	デストラクタ

限定公開メンバ関数
void	onConnect ()
	接続確立時にコールバックを呼ぶ

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

静的限定公開メンバ関数
static CdrBufferBase *	createBuffer (ConnectorInfo &info)
	Bufferの生成

その他の継承メンバ
基底クラス RTC::InPortConnector に属する継承限定公開変数類
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
	シリアライザへの参照

詳解

InPortPullConnector クラス

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

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

InPortConsumer
Buffer

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

引数

info	ConnectorInfo
consumer	OutPortConsumer
listeners	ConnectorListeners 型のリスナオブジェクトリスト
buffer	CdrBufferBase 型のバッファ

◆ ~InPortPullConnector()

RTC::InPortPullConnector::~InPortPullConnector ( )

override

デストラクタ

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

関数詳解

◆ activate()

void RTC::InPortPullConnector::activate ( )

inlineoverridevirtual

アクティブ化

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

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

◆ createBuffer()

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

staticprotected

Bufferの生成

与えられた接続情報に基づきバッファを生成する。

引数

info 接続情報

戻り値: バッファへのポインタ

◆ deactivate()

void RTC::InPortPullConnector::deactivate ( )

inlineoverridevirtual

非アクティブ化

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

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

◆ disconnect()

DataPortStatus RTC::InPortPullConnector::disconnect ( )

overridevirtual

接続解除関数

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

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

◆ onConnect()

void RTC::InPortPullConnector::onConnect ( )

protected

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

◆ onDisconnect()

void RTC::InPortPullConnector::onDisconnect ( )

protected

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

◆ read()

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

overridevirtual

read 関数

OutPortConsumer からデータを取得する。正常に読み出せた場合、戻り値は PORT_OK となり、data に読み出されたデータが格納される。それ以外の場合には、エラー値として BUFFER_EMPTY, TIMEOUT, PRECONDITION_NOT_MET, PORT_ERROR が返される。

戻り値: PORT_OK 正常終了 BUFFER_EMPTY バッファは空である TIMEOUT タイムアウトした PRECONDITION_NOT_MET 事前条件を満たさない PORT_ERROR その他のエラー

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

◆ unsubscribeInterface()

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

overridevirtual

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

引数

prop	コネクタプロファイルのプロパティ

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

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

InPortPullConnector.h

公開メンバ関数

限定公開メンバ関数

静的限定公開メンバ関数

その他の継承メンバ

詳解

構築子と解体子

◆ InPortPullConnector()

◆ ~InPortPullConnector()

関数詳解

◆ activate()

◆ createBuffer()

◆ deactivate()

◆ disconnect()

◆ onConnect()

◆ onDisconnect()

◆ read()

◆ unsubscribeInterface()