OpenRTM_aist.InPortCSPConsumer.InPortCSPConsumer クラス

[詳解]

OpenRTM_aist.InPortCSPConsumer.InPortCSPConsumer の継承関係図

公開メンバ関数
def	__init__ (self)
def	__del__ (self, CorbaConsumer=OpenRTM_aist.CorbaConsumer)
def	init (self, prop)
def	setBuffer (self, buffer)
def	put (self, data)
def	isWritable (self, retry=False)
基底クラス OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer に属する継承公開メンバ関数
def	__init__ (self)
def	__del__ (self, CorbaConsumer=OpenRTM_aist.CorbaConsumer)
def	init (self, prop)
def	put (self, data)
def	publishInterfaceProfile (self, properties)
def	subscribeInterface (self, properties)
def	unsubscribeInterface (self, properties)
def	subscribeFromIor (self, properties)
def	subscribeFromRef (self, properties)
def	unsubscribeFromIor (self, properties)
def	unsubscribeFromRef (self, properties)
def	convertReturnCode (self, ret)
基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承公開メンバ関数
def	toString (status)
基底クラス OpenRTM_aist.CorbaConsumer.CorbaConsumer に属する継承公開メンバ関数
def	__init__ (self, interfaceType=None, consumer=None)
def	equal (self, consumer)
def	setObject (self, obj)
def	releaseObject (self)
基底クラス OpenRTM_aist.CorbaConsumer.CorbaConsumerBase に属する継承公開メンバ関数
def	__init__ (self, consumer=None)
def	equal (self, consumer)
def	setObject (self, obj)
def	getObject (self)
def	releaseObject (self)

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

詳解

InPortCSPConsumer クラス

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

構築子と解体子

__init__()

def OpenRTM_aist.InPortCSPConsumer.InPortCSPConsumer.__init__

(

self

)

コンストラクタ

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

self

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

__del__()

def OpenRTM_aist.InPortCSPConsumer.InPortCSPConsumer.__del__	(		self,
			CorbaConsumer = OpenRTM_aist.CorbaConsumer
	)

デストラクタ

デストラクタ

引数

self

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

メソッド詳解

init()

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

設定初期化

InPortConsumerの各種設定を行う

virtual void init(coil::Properties& prop);

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

isWritable()

def OpenRTM_aist.InPortCSPConsumer.InPortCSPConsumer.isWritable	(		self,
			retry = False
	)

書き込み可能かを接続先のProviderに確認

引数

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

戻り値

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

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

put()

def OpenRTM_aist.InPortCSPConsumer.InPortCSPConsumer.put	(		self,
			data
	)

バッファにデータを書き込む

引数

self
data	書込対象データ

戻り値

リターンコード PORT_OK：正常完了 PORT_ERROR：バッファ書き込みエラー、通常は発生しない SEND_FULL：バッファがフル SEND_TIMEOUT：書き込みタイムアウト UNKNOWN_ERROR：その他のエラー CONNECTION_LOST：通信エラー

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

setBuffer()

def OpenRTM_aist.InPortCSPConsumer.InPortCSPConsumer.setBuffer	(		self,
			buffer
	)

バッファをセットする

引数

buffer

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

virtual void setBuffer(CdrBufferBase* buffer);

---

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

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