OpenRTM_aist.OutPortDSConsumer.OutPortDSConsumer クラス

[詳解]

OpenRTM_aist.OutPortDSConsumer.OutPortDSConsumer の継承関係図

公開メンバ関数
def	__init__ (self)
def	__del__ (self, CorbaConsumer=OpenRTM_aist.CorbaConsumer)
def	init (self, prop)
def	setBuffer (self, buffer)
def	get (self)
def	subscribeInterface (self, properties)
def	unsubscribeInterface (self, properties)
def	convertReturn (self, status, data)
def	onBufferWrite (self, data)
	Connector data listener functions [詳解]
def	onSenderEmpty (self)
	Connector listener functions [詳解]
基底クラス 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 リターンコード [詳解]

詳解

OutPortDSConsumer クラス

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

引数

DataType

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

から

1.2.0

構築子と解体子

__init__()

def OpenRTM_aist.OutPortDSConsumer.OutPortDSConsumer.__init__

(

self

)

コンストラクタ

コンストラクタ

引数

buffer

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

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

__del__()

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

デストラクタ

デストラクタ

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

メソッド詳解

convertReturn()

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

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

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

get()

def OpenRTM_aist.OutPortDSConsumer.OutPortDSConsumer.get

(

self

)

データを読み出す

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

引数

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

戻り値

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

virtual ReturnCode get(cdrMemoryStream& data);

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

init()

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

設定初期化

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

引数

prop

設定情報

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

onBufferWrite()

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

Connector data listener functions

inline void onBufferWrite(const cdrMemoryStream& data)

onSenderEmpty()

def OpenRTM_aist.OutPortDSConsumer.OutPortDSConsumer.onSenderEmpty

(

self

)

Connector listener functions

inline void onSenderEmpty()

setBuffer()

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

バッファをセットする

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

引数

buffer

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

virtual void setBuffer(CdrBufferBase* buffer);

subscribeInterface()

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

データ受信通知への登録

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

引数

properties

登録情報

戻り値

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

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

unsubscribeInterface()

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

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

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

引数

properties

登録解除情報

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

---

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

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