OpenRTM_aist.OutPort.OutPort クラス

[詳解]

OpenRTM_aist.OutPort.OutPort の継承関係図

クラス
class	subscribe

公開メンバ関数
def	__init__ (self, name, value, buffer=None)
def	__del__ (self, OutPortBase=OpenRTM_aist.OutPortBase)
def	write (self, value=None)
def	setOnWrite (self, on_write)
def	setOnWriteConvert (self, on_wconvert)
def	getPortDataType (self)
def	read (self)
基底クラス OpenRTM_aist.OutPortBase.OutPortBase に属する継承公開メンバ関数
def	__init__ (self, name, data_type)
def	__del__ (self, PortBase=OpenRTM_aist.PortBase)
def	init (self, prop)
def	write (self)
def	connect (self, connector_profile)
def	notify_connect (self, connector_profile)
def	properties (self)
def	connectors (self)
def	getConnectorProfiles (self)
def	getConnectorIds (self)
def	getConnectorNames (self)
def	getConnectorById (self, id)
def	getConnectorByName (self, name)
def	getConnectorProfileById (self, id)
def	getConnectorProfileByName (self, name)
def	activateInterfaces (self)
def	deactivateInterfaces (self)
def	addConnectorDataListener (self, listener_type, listener)
def	removeConnectorDataListener (self, listener_type, listener)
def	addConnectorListener (self, callback_type, listener)
def	removeConnectorListener (self, callback_type, listener)
def	configure (self)
def	publishInterfaces (self, cprof)
def	subscribeInterfaces (self, cprof)
def	unsubscribeInterfaces (self, connector_profile)
def	initProviders (self)
def	initConsumers (self)
def	createProvider (self, cprof, prop)
def	createConsumer (self, cprof, prop)
def	createConnector (self, cprof, prop, provider_=None, consumer_=None)
def	createDuplexConnector (self, cprof, prop, provider_)
def	getLocalInPort (self, profile)
基底クラス OpenRTM_aist.PortBase.PortBase に属する継承公開メンバ関数
def	__init__ (self, name=None)
def	__del__ (self)
def	exit (self)
def	get_port_profile (self)
def	getPortProfile (self)
def	get_connector_profiles (self)
def	get_connector_profile (self, connector_id)
def	connect (self, connector_profile)
def	notify_connect (self, connector_profile)
def	disconnect (self, connector_id)
def	notify_disconnect (self, connector_id)
def	disconnect_all (self)
def	setName (self, name)
def	getName (self)
def	getProfile (self)
def	setPortRef (self, port_ref)
def	getPortRef (self)
def	setOwner (self, owner)
def	setOnPublishInterfaces (self, on_publish)
def	setOnSubscribeInterfaces (self, on_subscribe)
def	setOnConnected (self, on_connected)
def	setOnUnsubscribeInterfaces (self, on_subscribe)
def	setOnDisconnected (self, on_disconnected)
def	setPortConnectListenerHolder (self, portconnListeners)
def	publishInterfaces (self, connector_profile)
def	connectNext (self, connector_profile)
def	disconnectNext (self, connector_profile)
def	subscribeInterfaces (self, connector_profile)
def	unsubscribeInterfaces (self, connector_profile)
def	setConnectionLimit (self, limit_value)
def	isEmptyId (self, connector_profile)
def	getUUID (self)
def	setUUID (self, connector_profile)
def	isExistingConnId (self, id_)
def	findConnProfile (self, id_)
def	findConnProfileIndex (self, id_)
def	updateConnectorProfile (self, connector_profile)
def	eraseConnectorProfile (self, id_)
def	appendInterface (self, instance_name, type_name, pol)
def	deleteInterface (self, name, pol)
def	addProperty (self, key, value)
def	appendProperty (self, key, value)
def	updateConnectors (self)
def	checkPorts (self, ports)
def	isExistingMarshalingType (self, con_prop)
基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承公開メンバ関数
def	toString (status)

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

詳解

OutPort クラス

OutPort 用クラス

から

0.2.0

構築子と解体子

__init__()

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

コンストラクタ

コンストラクタ

引数

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

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

__del__()

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

デストラクタ

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

引数

self

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

メソッド詳解

getPortDataType()

def OpenRTM_aist.OutPort.OutPort.getPortDataType

(

self

)

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

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

引数

self

戻り値

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

read()

def OpenRTM_aist.OutPort.OutPort.read

(

self

)

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

引数

self

戻り値

読み込んだデータ

void read(const DataType& data)

setOnWrite()

def 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()

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

OnWriteConvert コールバックの設定

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

引数

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

write()

def 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を再実装しています。

---

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

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