OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer クラス

InPortCorbaCdrConsumer クラス [詳解]

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)
	InterfaceProfile情報を公開する [詳解]
def	subscribeInterface (self, properties)
	データ送信通知への登録 [詳解]
def	unsubscribeInterface (self, properties)
	データ送信通知からの登録解除 [詳解]
def	subscribeFromIor (self, properties)
	IOR文字列からオブジェクト参照を取得する [詳解]
def	subscribeFromRef (self, properties)
	Anyから直接オブジェクト参照を取得する [詳解]
def	unsubscribeFromIor (self, properties)
	接続解除(IOR版) [詳解]
def	unsubscribeFromRef (self, properties)
	接続解除(Object reference版) [詳解]
def	convertReturnCode (self, ret)
	リターンコード変換ReturnCode convertReturnCode(OpenRTM::PortStatus ret)
基底クラス 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 リターンコード [詳解]

詳解

InPortCorbaCdrConsumer クラス

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

引数

DataType

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

から

1.0

構築子と解体子

def OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer.__init__

(

self

)

コンストラクタ

コンストラクタ

引数

buffer

当該コンシューマに割り当てるバッファオブジェクト

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

デストラクタ

デストラクタ

メソッド詳解

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

設定初期化

InPortConsumerの各種設定を行う

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

def OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer.publishInterfaceProfile	(		self,
			properties
	)

InterfaceProfile情報を公開する

InterfaceProfile情報を公開する。 引数で指定するプロパティ情報内の NameValue オブジェクトの dataport.interface_type 値を調べ、当該ポートに設定されている インターフェースタイプと一致する場合のみ情報を取得する。

引数

properties

InterfaceProfile情報を受け取るプロパティ

virtual void publishInterfaceProfile(SDOPackage::NVList& properties);

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

接続先へのデータ送信

接続先のポートへデータを送信するための純粋仮想関数。

この関数は、以下のリターンコードを返す。

• PORT_OK: 正常終了。
• PORT_ERROR: データ送信の過程で何らかのエラーが発生した。
• SEND_FULL: データを送信したが、相手側バッファがフルだった。
• SEND_TIMEOUT: データを送信したが、相手側バッファがタイムアウトした。
• UNKNOWN_ERROR: 原因不明のエラー

引数

data

送信するデータ

戻り値

リターンコード

virtual ReturnCode put(const cdrMemoryStream& data);

def OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer.subscribeFromIor	(		self,
			properties
	)

IOR文字列からオブジェクト参照を取得する

戻り値

true: 正常取得, false: 取得失敗

bool subscribeFromIor(const SDOPackage::NVList& properties);

def OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer.subscribeFromRef	(		self,
			properties
	)

Anyから直接オブジェクト参照を取得する

戻り値

true: 正常取得, false: 取得失敗

bool subscribeFromRef(const SDOPackage::NVList& properties);

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

データ送信通知への登録

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

引数

properties

登録情報

戻り値

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

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

def OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer.unsubscribeFromIor	(		self,
			properties
	)

接続解除(IOR版)

戻り値

true: 正常取得, false: 取得失敗

bool unsubscribeFromIor(const SDOPackage::NVList& properties);

def OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer.unsubscribeFromRef	(		self,
			properties
	)

接続解除(Object reference版)

戻り値

true: 正常取得, false: 取得失敗

bool unsubscribeFromRef(const SDOPackage::NVList& properties);

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

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

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

引数

properties

登録解除情報

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

---

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

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