OpenRTM_aist.OutPort.OutPort の継承関係図

クラス
class	subscribe

公開メンバ関数
	__init__ (self, name, value, buffer=None)

	__del__ (self, OutPortBase=OpenRTM_aist.OutPortBase)

	write (self, value=None)

	setOnWrite (self, on_write)

	setOnWriteConvert (self, on_wconvert)

	getPortDataType (self)

	read (self)

基底クラス OpenRTM_aist.OutPortBase.OutPortBase に属する継承公開メンバ関数
	init (self, prop)

	connect (self, connector_profile)

	notify_connect (self, connector_profile)

	properties (self)

	connectors (self)

	getConnectorProfiles (self)

	getConnectorIds (self)

	getConnectorNames (self)

	getConnectorById (self, id)

	getConnectorByName (self, name)

	getConnectorProfileById (self, id)

	getConnectorProfileByName (self, name)

	activateInterfaces (self)

	deactivateInterfaces (self)

	addConnectorDataListener (self, listener_type, listener)

	removeConnectorDataListener (self, listener_type, listener)

	addConnectorListener (self, callback_type, listener)

	removeConnectorListener (self, callback_type, listener)

	configure (self)

	publishInterfaces (self, cprof)

	subscribeInterfaces (self, cprof)

	unsubscribeInterfaces (self, connector_profile)

	initProviders (self)

	initConsumers (self)

	createProvider (self, cprof, prop)

	createConsumer (self, cprof, prop)

	createConnector (self, cprof, prop, provider_=None, consumer_=None)

	createDuplexConnector (self, cprof, prop, provider_)

	getLocalInPort (self, profile)

基底クラス OpenRTM_aist.PortBase.PortBase に属する継承公開メンバ関数
	exit (self)

	get_port_profile (self)

	getPortProfile (self)

	get_connector_profiles (self)

	get_connector_profile (self, connector_id)

	disconnect (self, connector_id)

	notify_disconnect (self, connector_id)

	disconnect_all (self)

	setName (self, name)

	getName (self)

	getProfile (self)

	setPortRef (self, port_ref)

	getPortRef (self)

	setOwner (self, owner)

	setOnPublishInterfaces (self, on_publish)

	setOnSubscribeInterfaces (self, on_subscribe)

	setOnConnected (self, on_connected)

	setOnUnsubscribeInterfaces (self, on_subscribe)

	setOnDisconnected (self, on_disconnected)

	setPortConnectListenerHolder (self, portconnListeners)

	connectNext (self, connector_profile)

	disconnectNext (self, connector_profile)

	setConnectionLimit (self, limit_value)

	isEmptyId (self, connector_profile)

	getUUID (self)

	setUUID (self, connector_profile)

	isExistingConnId (self, id_)

	findConnProfile (self, id_)

	findConnProfileIndex (self, id_)

	updateConnectorProfile (self, connector_profile)

	eraseConnectorProfile (self, id_)

	appendInterface (self, instance_name, type_name, pol)

	deleteInterface (self, name, pol)

	addProperty (self, key, value)

	appendProperty (self, key, value)

	updateConnectors (self)

	checkPorts (self, ports)

	isExistingMarshalingType (self, con_prop)

基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承公開メンバ関数
	toString (status)

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

基底クラス OpenRTM_aist.PortBase.PortBase に属する継承限定公開メンバ関数
	_publishInterfaces (self)

詳解

OutPort クラス

OutPort 用クラス

から: 0.2.0

構築子と解体子

◆ init()

OpenRTM_aist.OutPort.OutPort.__init__	(	self,
		name,
		value,
		buffer = None )

コンストラクタ

引数

self
name	ポート名
value	このポートにバインドされるデータ変数
buffer_	バッファ

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

◆ del()

OpenRTM_aist.OutPort.OutPort.__del__	(		self,
			PortBase = OpenRTM_aist.OutPortBase )

デストラクタ

デストラクタ。登録された全ての Publisher を削除する。

引数

self

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

メソッド詳解

◆ getPortDataType()

OpenRTM_aist.OutPort.OutPort.getPortDataType ( self )

データ型名取得用メソッド

データの型名を取得するため、InPortCorbaProviderから呼ばれる。

引数

self

戻り値: バッファに設定されているデータの型名

◆ read()

OpenRTM_aist.OutPort.OutPort.read ( self )

データをダイレクトに読み込む

引数

self

戻り値: 読み込んだデータ

void read(const DataType& data)

◆ setOnWrite()

OpenRTM_aist.OutPort.OutPort.setOnWrite	(		self,
			on_write )

データ書き込み処理のブロックモードの設定

書き込み処理に対してブロックモードを設定する。ブロックモードを指定した場合、バッファに書き込む領域ができるかタイムアウトが発生するまで write() メソッドの呼びだしがブロックされる。

引数

self
block	ブロックモードフラグ

def setWriteBlock(self, block): self._writeBlock = block

書き込み処理のタイムアウト時間の設定

write() のタイムアウト時間を usec で設定する。 write() はブロックモードでなければならない。

引数

self
timeout	タイムアウト時間 [usec]

def setWriteTimeout(self, timeout): self._writeTimeout = timeout

OnWrite コールバックの設定

データ書き込み直前に呼ばれる OnWrite コールバックファンクタを設定する。

引数

self
on_write	OnWrite コールバックファンクタ

◆ setOnWriteConvert()

OpenRTM_aist.OutPort.OutPort.setOnWriteConvert	(		self,
			on_wconvert )

OnWriteConvert コールバックの設定

データ書き込み時に呼ばれる OnWriteConvert コールバックファンクタを設定する。このコールバック関数の処理結果が書き込まれる。このため書き込みデータのフィルタリングが可能となる。

引数

self
on_wconvert	OnWriteConvert コールバックファンクタ

◆ write()

OpenRTM_aist.OutPort.OutPort.write	(		self,
			value = None )

データ書き込み

ポートへデータを書き込む。

コールバックファンクタ OnWrite がセットされている場合、 OutPort が保持するバッファに書き込む前に OnWrite が呼ばれる。
OutPort が保持するバッファがオーバーフローを検出できるバッファであり、かつ、書き込む際にバッファがオーバーフローを検出した場合、コールバックファンクタ OnOverflow が呼ばれる。
コールバックファンクタ OnWriteConvert がセットされている場合、バッファ書き込み時に、 OnWriteConvert の operator() の戻り値がバッファに書き込まれる。

引数

self
value	書き込み対象データ

戻り値: 書き込み処理結果(書き込み成功:true、書き込み失敗:false)

virtual bool write(const DataType& value)

データ書き込み

ポートへデータを書き込む。設定された値をポートに書き込む。

引数

self
value	書き込み対象データ

戻り値: 書き込み処理結果(書き込み成功:true、書き込み失敗:false)

bool operator<<(DataType& value)

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

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

OutPort.py

クラス

公開メンバ関数

その他の継承メンバ

詳解

構築子と解体子

◆ __init__()

◆ __del__()

メソッド詳解

◆ getPortDataType()

◆ read()

◆ setOnWrite()

◆ setOnWriteConvert()

◆ write()

◆ init()

◆ del()