OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector クラス

OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector の継承関係図

公開メンバ関数
def	__init__ (self, info, provider, listeners, buffer=None)
def	__del__ (self)
def	write (self, data)
def	isWritable (self, retry=False)
def	read (self, data=None)
def	isReadable (self, retry=False)
def	setReadListener (self, listener)
def	setIsReadableListener (self, listener)
def	disconnect (self)
def	getBuffer (self)
def	activate (self)
def	deactivate (self)
def	createBuffer (self, info)
def	onConnect (self)
def	onDisconnect (self)
def	setConsumer (self, consumer)
def	serializeData (self, data)
def	unsubscribeInterface (self, prop)
基底クラス OpenRTM_aist.OutPortConnector.OutPortConnector に属する継承公開メンバ関数
def	__init__ (self, info)
def	__del__ (self)
def	profile (self)
def	id (self)
def	name (self)
def	setDirectMode (self)
def	directMode (self)
def	setConsumer (self, consumer)
def	unsubscribeInterface (self, prop)
def	__del__ (self)
def	profile (self)
def	id (self)
def	name (self)
def	disconnect (self)
def	getBuffer (self)
def	activate (self)
def	deactivate (self)
基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承公開メンバ関数
def	toString (status)

その他の継承メンバ
基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承静的公開変数類
int	PORT_OK = 0
	brief DataPortStatus リターンコード [詳解]

詳解

構築子と解体子

__init__()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.__init__	(		self,
			info,
			provider,
			listeners,
			buffer = None
	)

コンストラクタ

引数

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

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

OpenRTM_aist.OutPortConnector.OutPortConnectorを再実装しています。

__del__()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.__del__

(

self

)

デストラクタ

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

OpenRTM_aist.OutPortConnector.OutPortConnectorを再実装しています。

メソッド詳解

activate()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.activate

(

self

)

アクティブ化

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

virtual void activate(){}; // do nothing

OpenRTM_aist.ConnectorBase.ConnectorBaseを再実装しています。

createBuffer()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.createBuffer	(		self,
			info
	)

Bufferの生成

CdrBufferBase* createBuffer(ConnectorInfo& info);

deactivate()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.deactivate

(

self

)

非アクティブ化

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

virtual void deactivate(){}; // do nothing

OpenRTM_aist.ConnectorBase.ConnectorBaseを再実装しています。

disconnect()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.disconnect

(

self

)

接続解除

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

virtual ReturnCode disconnect();

OpenRTM_aist.ConnectorBase.ConnectorBaseを再実装しています。

getBuffer()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.getBuffer

(

self

)

Buffer を取得する

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

virtual CdrBufferBase* getBuffer();

OpenRTM_aist.ConnectorBase.ConnectorBaseを再実装しています。

isReadable()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.isReadable	(		self,
			retry = False
	)

データ読み込み可能かを確認 InPort側からリモートに呼び出す 内部でデータ読み込み確認時のリスナが呼び出される 戻り値はリスナに依存する

引数

self
retry	True：再検索、False：通常の読み込み確認

戻り値

True：読み込み可能、False：読み込み不可

OpenRTM_aist.OutPortConnector.OutPortConnectorを再実装しています。

isWritable()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.isWritable	(		self,
			retry = False
	)

データ書き込み可能かOutPort側に確認

設定したConsumerオブジェクトによりInPort側にデー化書き込み可能かを確認する 戻り値は設定したConsumerオブジェクトに依存する

引数

self
retry	True：再検索、False：通常の書き込み確認

戻り値

True：書き込み可能、False：書き込み不可

OpenRTM_aist.OutPortConnector.OutPortConnectorを再実装しています。

onConnect()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.onConnect

(

self

)

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

onDisconnect()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.onDisconnect

(

self

)

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

read()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.read	(		self,
			data = None
	)

データ読み込み InPort側からリモートに呼び出す 内部でデータ読み込み時のリスナが呼び出される 戻り値はリスナに依存する

引数

self
data	読み込んだデータを格納する変数

戻り値

リターンコード BUFFER_OK：正常完了 PRECONDITION_NOT_MET：エラー

OpenRTM_aist.OutPortConnector.OutPortConnectorを再実装しています。

serializeData()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.serializeData	(		self,
			data
	)

データの符号化

引数

self
cdr	符号化前のデータ

戻り値

ret, data ret：リターンコード PORT_OK：正常完了 PRECONDITION_NOT_MET：サポートされていないエンディアン SERIALIZE_ERROR：符号化処理でエラー PRECONDITION_NOT_MET：その他のエラー data：符号化後のデータ

setConsumer()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.setConsumer	(		self,
			consumer
	)

コンシューマの設定

OpenRTM_aist.OutPortConnector.OutPortConnectorを再実装しています。

setIsReadableListener()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.setIsReadableListener	(		self,
			listener
	)

データ読み込み確認時のリスナを登録

引数

self
listener	リスナ

OpenRTM_aist.OutPortConnector.OutPortConnectorを再実装しています。

setReadListener()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.setReadListener	(		self,
			listener
	)

データ読み込み時のリスナを登録

引数

self
listener	リスナ

OpenRTM_aist.OutPortConnector.OutPortConnectorを再実装しています。

unsubscribeInterface()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.unsubscribeInterface	(		self,
			prop
	)

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

引数

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

OpenRTM_aist.OutPortConnector.OutPortConnectorを再実装しています。

write()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.write	(		self,
			data
	)

データの書き込み

設定したConsumerオブジェクトによりInPort側にデータを送信する 戻り値は設定したConsumerオブジェクトに依存する

引数

self
data	書き込むデータ

戻り値

リターンコード

virtual ReturnCode write(const cdrMemoryStream& data);

OpenRTM_aist.OutPortConnector.OutPortConnectorを再実装しています。

---

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

• C:/docs/OpenRTM-aist-Python/OpenRTM_aist/OutPortDuplexConnector.py