OpenRTM_aist.EventPort_pyfsm.EventInPort クラス

[詳解]

OpenRTM_aist.EventPort_pyfsm.EventInPort の継承関係図

公開メンバ関数
	__init__ (self, name, fsm, bufsize=64, read_block=False, write_block=False, read_timeout=0, write_timeout=0)
	__del__ (self)
	name (self)
	init (self, prop)
基底クラス OpenRTM_aist.InPortBase.InPortBase に属する継承公開メンバ関数
	read (self)
	properties (self)
	connectors (self)
	getConnectorProfiles (self)
	getConnectorIds (self)
	getConnectorNames (self)
	getConnectorById (self, id)
	getConnectorByName (self, name)
	getConnectorProfileById (self, id)
	getConnectorProfileByName (self, name)
	connect (self, connector_profile)
	notify_connect (self, connector_profile)
	activateInterfaces (self)
	deactivateInterfaces (self)
	addConnectorDataListener (self, listener_type, listener)
	removeConnectorDataListener (self, listener_type, listener)
	addConnectorListener (self, listener_type, listener)
	removeConnectorListener (self, listener_type, listener)
	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_)
	getLocalOutPort (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)

詳解

EventInPort テンプレートクラス

EventInPort の実装である EventInPort<T> のテンプレートクラス。 <T> はBasicDataType.idl にて定義されている型で、メンバとして Time 型の tm , および T型の data を持つ構造体でなくてはならない。 EventInPort は内部にリングバッファを持ち、外部から送信されたデータを順次 このリングバッファに格納する。リングバッファのサイズはデフォルトで64と なっているが、コンストラクタ引数によりサイズを指定することができる。 データはフラグによって未読、既読状態が管理され、isNew(), write(), read(), isFull(), isEmpty() 等のメソッドによりハンドリングすることができる。

OnRead系コールバック (読み出しに起因するイベントによりコールされる)

• void OnRead.operator(): EventInPort.read() を呼び出し読み出しを行う際にコールされる。
• DataType OnReadConvert.operator(DataType): EventInPort.read() を呼び出し、データをバッファから読みだす際に呼ばれ データの変換を行う。引数にはバッファから読み出された値が与えられ、 変換後のデータを戻り値として返す。この値がread()の返す値となる。

から

0.2.0

構築子と解体子

__init__()

OpenRTM_aist.EventPort_pyfsm.EventInPort.__init__	(		self,
			name,
			fsm,
			bufsize = 64,
			read_block = False,
			write_block = False,
			read_timeout = 0,
			write_timeout = 0 )

コンストラクタ

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

引数

name	EventInPort 名。EventInPortBase:name() により参照される。
value	この EventInPort にバインドされる T 型の変数
bufsize	EventInPort 内部のリングバッファのバッファ長(デフォルト値:64)
read_block	読込ブロックフラグ。 データ読込時に未読データがない場合、次のデータ受信までブロックする かどうかを設定(デフォルト値:false)
write_block	書込ブロックフラグ。 データ書込時にバッファがフルであった場合、バッファに空きができる までブロックするかどうかを設定(デフォルト値:false)
read_timeout	読込ブロックを指定していない場合の、データ読取タイム アウト時間(ミリ秒)(デフォルト値:0)
write_timeout	書込ブロックを指定していない場合の、データ書込タイム アウト時間(ミリ秒)(デフォルト値:0)

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

__del__()

OpenRTM_aist.EventPort_pyfsm.EventInPort.__del__

(

self

)

デストラクタ

デストラクタ。

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

メソッド詳解

init()

OpenRTM_aist.EventPort_pyfsm.EventInPort.init	(		self,
			prop )

プロパティの初期化

指定されたプロパティで初期化する。

引数

prop

設定するプロパティ

void init(coil.Properties& prop);

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

name()

OpenRTM_aist.EventPort_pyfsm.EventInPort.name

(

self

)

ポート名称を取得する。

ポート名称を取得する。

戻り値

ポート名称

---

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

• EventPort_pyfsm.py