OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider クラス

[詳解]

OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider の継承関係図

公開メンバ関数
def	__init__ (self)
def	__del__ (self)
def	exit (self)
def	init (self, prop)
def	setBuffer (self, buffer)
def	setListener (self, info, listeners)
def	setConnector (self, connector)
def	get (self)
def	onBufferRead (self, data)
def	onSend (self, data)
def	onBufferEmpty (self)
def	onBufferReadTimeout (self)
def	onSenderEmpty (self)
def	onSenderTimeout (self)
def	onSenderError (self)
def	convertReturn (self, status, data)
基底クラス OpenRTM_aist.OutPortProvider.OutPortProvider に属する継承公開メンバ関数
def	__init__ (self)
def	exit (self)
def	publishInterfaceProfile (self, prop)
def	publishInterface (self, prop)
def	setPortType (self, port_type)
def	setDataType (self, data_type)
def	setInterfaceType (self, interface_type)
def	setDataFlowType (self, dataflow_type)
def	setSubscriptionType (self, subs_type)
基底クラス OpenRTM_aist.DataPortStatus.DataPortStatus に属する継承公開メンバ関数
def	toString (status)

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

詳解

OutPortCorbaCdrProvider クラス

OutPortProvider

データ転送に CORBA の OpenRTM::OutPortCdr インターフェースを利用し た、pull 型データフロー型を実現する OutPort プロバイダクラス。

から

0.4.0

構築子と解体子

__init__()

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.__init__

(

self

)

コンストラクタ

コンストラクタ

引数

buffer

当該プロバイダに割り当てるバッファオブジェクト

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

__del__()

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.__del__

(

self

)

デストラクタ

デストラクタ

メソッド詳解

convertReturn()

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

リターンコード変換

::OpenRTM::PortStatus convertReturn(BufferStatus::Enum status, const cdrMemoryStream& data);

exit()

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.exit

(

self

)

終了処理

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

get()

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.get

(

self

)

[CORBA interface] バッファからデータを取得する

設定された内部バッファからデータを取得する。

戻り値

取得データ

virtual ::OpenRTM::PortStatus get(::OpenRTM::CdrData_out data);

init()

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

設定初期化

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

引数

prop

設定情報

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

onBufferEmpty()

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onBufferEmpty

(

self

)

ON_BUFFER_EMPTYのリスナへ通知する。

inline void onBufferEmpty()

onBufferRead()

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onBufferRead	(		self,
			data
	)

ON_BUFFER_READ のリスナへ通知する。

引数

data	cdrMemoryStream

inline void onBufferRead(const cdrMemoryStream& data)

onBufferReadTimeout()

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onBufferReadTimeout

(

self

)

ON_BUFFER_READ_TIMEOUT のリスナへ通知する。

inline void onBufferReadTimeout()

onSend()

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onSend	(		self,
			data
	)

ON_SEND のリスナへ通知する。

引数

data	cdrMemoryStream

inline void onSend(const cdrMemoryStream& data)

onSenderEmpty()

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onSenderEmpty

(

self

)

ON_SENDER_EMPTYのリスナへ通知する。

inline void onSenderEmpty()

onSenderError()

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onSenderError

(

self

)

ON_SENDER_ERRORのリスナへ通知する。

inline void onSenderError()

onSenderTimeout()

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.onSenderTimeout

(

self

)

ON_SENDER_TIMEOUT のリスナへ通知する。

inline void onSenderTimeout()

setBuffer()

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

バッファをセットする

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

引数

buffer

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

virtual void setBuffer(BufferBase<cdrMemoryStream>* buffer);

setConnector()

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.setConnector	(		self,
			connector
	)

Connectorを設定する。

OutPort は接続確立時に OutPortConnector オブジェクトを生成し、生 成したオブジェクトのポインタと共にこの関数を呼び出す。所有権は OutPort が保持するので OutPortProvider は OutPortConnector を削 除してはいけない。

引数

connector

OutPortConnector

virtual void setConnector(OutPortConnector* connector);

setListener()

def OpenRTM_aist.OutPortCorbaCdrProvider.OutPortCorbaCdrProvider.setListener	(		self,
			info,
			listeners
	)

リスナを設定する。

OutPort はデータ送信処理における各種イベントに対して特定のリスナ オブジェクトをコールするコールバック機構を提供する。詳細は ConnectorListener.h の ConnectorDataListener, ConnectorListener 等を参照のこと。OutPortCorbaCdrProvider では、以下のコールバック が提供される。

• ON_BUFFER_READ
• ON_SEND
• ON_BUFFER_EMPTY
• ON_BUFFER_READ_TIMEOUT
• ON_SENDER_EMPTY
• ON_SENDER_TIMEOUT
• ON_SENDER_ERROR

引数

info	接続情報
listeners	リスナオブジェクト

virtual void setListener(ConnectorInfo& info, ConnectorListeners* listeners);

---

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

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