OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer の継承関係図

公開メンバ関数
	__init__ (self)

	__del__ (self, CorbaConsumer=OpenRTM_aist.CorbaConsumer)

	init (self, prop)

	setBuffer (self, buffer)

	get (self)

	isReadable (self, retry=False)

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

	unsubscribeInterface (self, properties)

	convertReturn (self, status, data)

	onBufferWrite (self, data)
	Connector data listener functions

	onSenderEmpty (self)
	Connector listener functions

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

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

	setObject (self, obj)

	releaseObject (self)

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

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

基底クラス OpenRTM_aist.CorbaConsumer.CorbaConsumer に属する継承限定公開メンバ関数
	_ptr (self, get_ref=False)

詳解

OutPortCSPConsumer クラス

CSPモデルのチャネルを模擬した出力ポートプロバイダーの実装クラス。

構築子と解体子

◆ init()

OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer.__init__ ( self )

コンストラクタ

コンストラクタ Interface Typeにはshared_memoryを指定する共有メモリの空間名はUUIDで作成し、コネクタプロファイルのdataport.shared_memory.addressに保存する

self

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

◆ del()

OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer.__del__	(		self,
			CorbaConsumer = OpenRTM_aist.CorbaConsumer )

デストラクタ

引数

self

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

メソッド詳解

◆ get()

OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer.get ( self )

接続先のProviderからデータを取得する

引数

data データの格納先

戻り値: リターンコード PORT_OK：正常終了 PORT_ERROR：バッファの読み込みエラー、通常は発生しない BUFFER_FULL：バッファフル、通常は発生しない BUFFER_EMPTY：バッファが空 BUFFER_TIMEOUT：一定時間以内にバッファにデータが追加されなかった CONNECTION_LOST：通信エラー UNKNOWN_ERROR：その他のエラー

OpenRTM.PortStatus put() throw (CORBA.SystemException);

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

◆ init()

OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer.init	(		self,
			prop )

設定初期化

OutPortConsumerの各種設定を行う。実装クラスでは、与えられた Propertiesから必要な情報を取得して各種設定を行う。この init() 関数は、OutPortProvider生成直後および、接続時にそれぞれ呼ばれる可能性がある。したがって、この関数は複数回呼ばれることを想定して記述されるべきである。

引数

prop 設定情報

virtual void init(coil.Properties& prop);

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

◆ isReadable()

OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer.isReadable	(		self,
			retry = False )

データ読み込み可能かを接続先のproviderに確認

引数

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

戻り値: True：読み込み可能、False：読み込み不可通信エラーが発生した場合はFalseを返す

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

◆ setBuffer()

OpenRTM_aist.OutPortCSPConsumer.OutPortCSPConsumer.setBuffer	(		self,
			buffer )

バッファをセットする

引数

buffer OutPortProviderがデータを取り出すバッファへのポインタ

virtual void setBuffer(CdrBufferBase* buffer);

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

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

OutPortCSPConsumer.py

公開メンバ関数

その他の継承メンバ

詳解

構築子と解体子

◆ __init__()

◆ __del__()

メソッド詳解

◆ get()

◆ init()

◆ isReadable()

◆ setBuffer()

◆ init()

◆ del()