クラス OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer

OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumerに対する継承グラフ

Public メソッド
def	__init__
	コンストラクタ
def	__del__
def	init
	設定初期化
def	setBuffer
	バッファをセットする
def	get
	データを読み出す
def	subscribeInterface
	データ受信通知への登録
def	unsubscribeInterface
	データ受信通知からの登録解除
def	convertReturn
	リターンコード変換 (DataPortStatus -> BufferStatus)
def	onBufferWrite
	Connector data listener functions.
def	onSenderEmpty
	Connector listener functions.

説明

OutPortCorbaCdrConsumer クラス.

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

引数:

DataType

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

から:: 1.0.0

メソッド

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

デストラクタ

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.__init__ ( self )

コンストラクタ

引数:

buffer

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

OpenRTM_aist.DataPortStatus.DataPortStatusを再定義しています。

def OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer.convertReturn	(	self,
		status,
		data
	)

リターンコード変換 (DataPortStatus -> BufferStatus)

ReturnCode convertReturn(OpenRTM.PortStatus status, const cdrMemoryStream& data)

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);

このクラスの説明は次のファイルから生成されました:

/var/lib/jenkins/jobs/01_openrtm-python-build-tags/workspace/OpenRTM_aist/OutPortCorbaCdrConsumer.py

クラス OpenRTM_aist.OutPortCorbaCdrConsumer.OutPortCorbaCdrConsumer

Public メソッド

説明

メソッド