OpenRTM_aist.CSPOutPort.CSPOutPort クラス

OpenRTM_aist.CSPOutPort.CSPOutPort の継承関係図

クラス
class	IsReadableListener
class	ReadListener
class	WorkerThreadCtrl

公開メンバ関数
def	__init__ (self, name, value, manager=None)
def	__del__ (self)
def	name (self)
def	init (self, prop)
def	setManager (self, manager)
def	releaseManager (self)
def	notify_connect (self, connector_profile)
def	dataWritable (self)
def	dataWritableRetry (self)
def	select (self)
def	reselect (self)
def	setSyncMode (self, mode)
def	getSyncMode (self)
def	writeData (self, value=None)
def	setData (self, data)
def	write (self, value=None)
基底クラス 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 リターンコード [詳解]

構築子と解体子

__init__()

def OpenRTM_aist.CSPOutPort.CSPOutPort.__init__	(		self,
			name,
			value,
			manager = None
	)

コンストラクタ

コンストラクタ。 パラメータとして与えられる T 型の変数にバインドされる。

引数

name	EventInPort 名。EventInPortBase:name() により参照される。
value	この EventInPort にバインドされる T 型の変数

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

__del__()

def OpenRTM_aist.CSPOutPort.CSPOutPort.__del__

(

self

)

デストラクタ

デストラクタ。

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

メソッド詳解

dataWritable()

def OpenRTM_aist.CSPOutPort.CSPOutPort.dataWritable

(

self

)

データが書き込み可能かを確認

引数

self

戻り値

ret, con ret：True(書き込み可能)、False(書き込み不可) con：書き込み可能なコネクタ。書き込み不可の場合はNone

dataWritableRetry()

def OpenRTM_aist.CSPOutPort.CSPOutPort.dataWritableRetry

(

self

)

データの再送信確認を行う

引数

self

戻り値

ret, con ret：True(書き込み可能)、False(書き込み不可) con：書き込み可能なコネクタ。書き込み不可の場合はNone

getSyncMode()

def OpenRTM_aist.CSPOutPort.CSPOutPort.getSyncMode

(

self

)

ロックモード、非ロックモードの取得

引数

self

戻り値

True：ロックモード、False：非ロックモード

init()

def OpenRTM_aist.CSPOutPort.CSPOutPort.init	(		self,
			prop
	)

初期化関数

引数

self
prop	設定情報 channel_timeout：データ書き込み、読み込み時のタイムアウト

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

name()

def OpenRTM_aist.CSPOutPort.CSPOutPort.name

(

self

)

ポート名称を取得する。

ポート名称を取得する。

引数

self

戻り値

ポート名称

notify_connect()

def OpenRTM_aist.CSPOutPort.CSPOutPort.notify_connect	(		self,
			connector_profile
	)

コネクタ接続関数 OutPortBaseの接続処理のほかに、コネクタに読み込み確認時、読み込み時のコールバック関数を設定する

引数

self
connector_profile	コネクタプロファイル

戻り値

ret, prof ret：リターンコード prof：コネクタプロファイル

ポート名称

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

releaseManager()

def OpenRTM_aist.CSPOutPort.CSPOutPort.releaseManager

(

self

)

CSPManagerの設定解除

引数

self

reselect()

def OpenRTM_aist.CSPOutPort.CSPOutPort.reselect

(

self

)

再検索リストのコネクタからデータ書き込み可能なコネクタを選択し、 self._writableConnectorに格納する

引数

self

戻り値

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

select()

def OpenRTM_aist.CSPOutPort.CSPOutPort.select

(

self

)

書き込み可能なコネクタを選択してself._writableConnectorに格納する

引数

self

戻り値

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

setData()

def OpenRTM_aist.CSPOutPort.CSPOutPort.setData	(		self,
			data
	)

待機状態時に移行した場合にデータを一時的に変数に格納する

引数

self
data	データ

setManager()

def OpenRTM_aist.CSPOutPort.CSPOutPort.setManager	(		self,
			manager
	)

CSPManagerの設定

引数

self
manager	CSPManager

setSyncMode()

def OpenRTM_aist.CSPOutPort.CSPOutPort.setSyncMode	(		self,
			mode
	)

ロックモード、非ロックモードの設定 データの送受信時は片方がコネクタ選択時にスレッドをロックするロックモード、 もう片方がスレッドをロックしない非ロックモードに設定する必要がある。 非ロックモードの場合はデータ選択時にis_writable、is_readable関数が呼ばれた場合、 再検索するコネクタのリストに追加して後で再検索する。

引数

self
mode	True：ロックモード、False：非ロックモード

write()

def OpenRTM_aist.CSPOutPort.CSPOutPort.write	(		self,
			value = None
	)

データを書き込む 書き込み可能なコネクタが存在する場合は、データを書き込んで処理を終了する 書き込み可能なコネクタが存在しない場合は、InPort側からデータを読み込むまで待機する

引数

self
value	データ

戻り値

True：正常完了、False：エラー データのマーシャリング、書き込みのタイムアウトでエラーが発生する

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

writeData()

def OpenRTM_aist.CSPOutPort.CSPOutPort.writeData	(		self,
			value = None
	)

self._writableConnectorに格納したコネクタにデータを書き込む このため、事前にselect関数を実行する必要がある

引数

self
value	データ

---

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

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