OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer クラス

OutPortCorbaCdrConsumer クラス [詳解]

OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer の継承関係図

公開メンバ関数
def	__init__ (self)
	コンストラクタ [詳解]
def	__del__ (self, CorbaConsumer=OpenRTM_aist.CorbaConsumer)
	デストラクタ [詳解]
def	init (self, prop)
	設定初期化 [詳解]
def	setBuffer (self, buffer)
	バッファをセットする [詳解]
def	get (self, data)
	データを読み出す [詳解]
def	subscribeInterface (self, properties)
	データ受信通知への登録 [詳解]
def	unsubscribeInterface (self, properties)
	データ受信通知からの登録解除 [詳解]
def	convertReturn (self, status, data)
	リターンコード変換 (DataPortStatus -> BufferStatus)ReturnCode convertReturn(::OpenRTM::PortStatus status, const cdrMemoryStream& data)
def	onBufferWrite (self, data)
	Connector data listener functions. [詳解]
def	onSenderEmpty (self)
	Connector listener functions. [詳解]
基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承公開メンバ関数
def	toString (status)
	DataPortStatus リターンコードを文字列に変換 [詳解]
基底クラス OpenRTM_aist.CorbaConsumer.CorbaConsumer に属する継承公開メンバ関数
def	__init__ (self, interfaceType=None, consumer=None)
	コンストラクタ [詳解]
def	equal (self, consumer)
	代入演算子 [詳解]
def	setObject (self, obj)
	オブジェクトをセットする [詳解]
def	releaseObject (self)
	CORBAオブジェクトの設定をクリアする [詳解]
基底クラス OpenRTM_aist.CorbaConsumer.CorbaConsumerBase に属する継承公開メンバ関数
def	__init__ (self, consumer=None)
	コンストラクタ [詳解]
def	equal (self, consumer)
	代入演算子 [詳解]
def	setObject (self, obj)
	CORBAオブジェクトをセットする [詳解]
def	getObject (self)
	CORBAオブジェクトを取得する [詳解]
def	releaseObject (self)
	CORBAオブジェクトの設定をクリアする [詳解]

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

詳解

OutPortCorbaCdrConsumer クラス

通信手段に CORBA を利用した出力ポートコンシューマの実装クラス。

引数

DataType

本ポートにて扱うデータ型

から

1.0.0

構築子と解体子

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.__init__

(

self

)

コンストラクタ

コンストラクタ

引数

buffer

本ポートに割り当てるバッファ

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

デストラクタ

デストラクタ

メソッド詳解

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.get	(		self,
			data
	)

データを読み出す

設定されたデータを読み出す。

引数

data	読み出したデータを受け取るオブジェクト

戻り値

データ読み出し処理結果(読み出し成功:true、読み出し失敗:false)

virtual ReturnCode get(cdrMemoryStream& data);

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

設定初期化

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

引数

prop

設定情報

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

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.onBufferWrite	(		self,
			data
	)

Connector data listener functions.

inline void onBufferWrite(const cdrMemoryStream& data)

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.onSenderEmpty

(

self

)

Connector listener functions.

inline void onSenderEmpty()

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

バッファをセットする

OutPortConsumerがデータを取り出すバッファをセットする。 すでにセットされたバッファがある場合、以前のバッファへの ポインタに対して上書きされる。 OutPortProviderはバッファの所有権を仮定していないので、 バッファの削除はユーザの責任で行わなければならない。

引数

buffer

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

virtual void setBuffer(CdrBufferBase* buffer);

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.subscribeInterface	(		self,
			properties
	)

データ受信通知への登録

指定されたプロパティに基づいて、データ受信通知の受け取りに登録する。

引数

properties

登録情報

戻り値

登録処理結果(登録成功:true、登録失敗:false)

virtual bool subscribeInterface(const SDOPackage::NVList& properties);

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.unsubscribeInterface	(		self,
			properties
	)

データ受信通知からの登録解除

データ受信通知の受け取りから登録を解除する。

引数

properties

登録解除情報

virtual void unsubscribeInterface(const SDOPackage::NVList& properties);

---

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

• /tmp/workspace/03_openrtm-python-build-tags/OpenRTM_aist/OutPortCorbaCdrConsumer.py