クラス OpenRTM_aist.PublisherFlush.PublisherFlush

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

Public メソッド
def	__init__
	コンストラクタ
def	__del__
	デストラクタ
def	init
	初期化
def	setConsumer
	InPortコンシューマのセット.
def	setBuffer
	バッファのセット
def	setListener
	リスナを設定する。
def	write
	データを書き込む
def	isActive
	アクティブ化確認
def	activate
	アクティブ化する
def	deactivate
	非アクティブ化する
def	onSend
	ON_SENDのリスナへ通知する。.
def	onReceived
	ON_RECEIVEDのリスナへ通知する。.
def	onReceiverFull
	ON_RECEIVER_FULLのリスナへ通知する。.
def	onReceiverTimeout
	ON_RECEIVER_TIMEOUTのリスナへ通知する。.
def	onReceiverError
	ON_RECEIVER_ERRORのリスナへ通知する。.

説明

PublisherFlush クラス.

Flush 型 Publisher クラスバッファ内に格納されている未送信データを送信する。データ送出を待つコンシューマを、送出する側と同じスレッドで動作させる。

メソッド

def OpenRTM_aist.PublisherFlush.PublisherFlush.__del__ ( self )

デストラクタ

デストラクタ当該Publisherを破棄する際に、PublisherFactoryにより呼び出される。

引数:

self

def OpenRTM_aist.PublisherFlush.PublisherFlush.__init__ ( self )

コンストラクタ

引数:

	self
	consumer	データ送出を待つコンシューマ
	property	本Publisherの駆動制御情報を設定したPropertyオブジェクト

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

def OpenRTM_aist.PublisherFlush.PublisherFlush.activate ( self )

アクティブ化する

Publisher をアクティブ化する。この関数を呼び出すことにより、 Publisherが持つ、データを送信するスレッドが動作を開始する。初期化が行われていないなどにより、事前条件を満たさない場合、エラーコード PRECONDITION_NOT_MET を返す。

戻り値:: PORT_OK 正常終了 PRECONDITION_NOT_MET 事前条件を満たさない

PublisherBase.ReturnCode PublisherFlush.activate()

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

def OpenRTM_aist.PublisherFlush.PublisherFlush.deactivate ( self )

非アクティブ化する

Publisher を非アクティブ化する。この関数を呼び出すことにより、 Publisherが持つ、データを送信するスレッドが動作を停止する。初期化が行われていないなどにより、事前条件を満たさない場合、エラーコード PRECONDITION_NOT_MET を返す。

戻り値:: PORT_OK 正常終了 PRECONDITION_NOT_MET 事前条件を満たさない

PublisherBase.ReturnCode PublisherFlush.deactivate()

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

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

初期化

このクラスのオブジェクトを使用するのに先立ち、必ずこの関数を呼び出す必要がある。ただし、この PublisherFlush は現状で初期化するパラメータを持たない。

引数:

property

本Publisherの駆動制御情報を設定したPropertyオブジェクト

戻り値:: ReturnCode PORT_OK 正常終了 INVALID_ARGS Properties が不正な値を含む

virtual ReturnCode init(coil.Properties& prop);

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

def OpenRTM_aist.PublisherFlush.PublisherFlush.isActive ( self )

アクティブ化確認

Publisher はデータポートと同期して activate/deactivate される。 activate() / deactivate() 関数によって、アクティブ状態と非アクティブ状態が切り替わる。この関数により、現在アクティブ状態か、非アクティブ状態かを確認することができる。

戻り値:: 状態確認結果(アクティブ状態:true、非アクティブ状態:false)

bool PublisherFlush.isActive()

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

def OpenRTM_aist.PublisherFlush.PublisherFlush.onReceived	(	self,
		data
	)

ON_RECEIVEDのリスナへ通知する。.

引数:

data

cdrMemoryStream

inline void onReceived(const cdrMemoryStream& data)

def OpenRTM_aist.PublisherFlush.PublisherFlush.onReceiverError	(	self,
		data
	)

ON_RECEIVER_ERRORのリスナへ通知する。.

引数:

data

cdrMemoryStream

inline void onReceiverError(const cdrMemoryStream& data)

def OpenRTM_aist.PublisherFlush.PublisherFlush.onReceiverFull	(	self,
		data
	)

ON_RECEIVER_FULLのリスナへ通知する。.

引数:

data

cdrMemoryStream

inline void onReceiverFull(const cdrMemoryStream& data)

def OpenRTM_aist.PublisherFlush.PublisherFlush.onReceiverTimeout	(	self,
		data
	)

ON_RECEIVER_TIMEOUTのリスナへ通知する。.

引数:

data

cdrMemoryStream

inline void onReceiverTimeout(const cdrMemoryStream& data)

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

ON_SENDのリスナへ通知する。.

引数:

data

cdrMemoryStream

inline void onSend(const cdrMemoryStream& data)

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

バッファのセット

PublisherFlushでは、バッファを使用しないため、いかなる場合も PORT_OK を返す。

引数:

buffer

CDRバッファ

戻り値:: PORT_OK 正常終了

PublisherBase.ReturnCode PublisherFlush.setBuffer(CdrBufferBase* buffer)

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

def OpenRTM_aist.PublisherFlush.PublisherFlush.setConsumer	(	self,
		consumer
	)

InPortコンシューマのセット.

この関数では、この Publisher に関連付けられるコンシューマをセットする。コンシューマオブジェクトがヌルポインタの場合、INVALID_ARGSが返される。それ以外の場合は、PORT_OK が返される。

引数:

consumer

Consumer へのポインタ

戻り値:: ReturnCode PORT_OK 正常終了 INVALID_ARGS 引数に不正な値が含まれている

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

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

リスナを設定する。

Publisher に対してリスナオブジェクト ConnectorListeners を設定する。各種リスナオブジェクトを含む ConnectorListeners をセットすることで、バッファの読み書き、データの送信時等にこれらのリスナをコールする。 ConnectorListeners オブジェクトの所有権はポートまたは RTObject が持ち Publisher 削除時に ConnectorListeners は削除されることはない。 ConnectorListeners がヌルポインタの場合 INVALID_ARGS を返す。

引数:

	info	ConnectorProfile をローカル化したオブジェクト ConnectorInfo
	listeners	リスナを多数保持する ConnectorListeners オブジェクト

戻り値:: PORT_OK 正常終了 INVALID_ARGS 不正な引数

virtual RTC.DataPortStatus.Enum setListener(ConnectorInfo& info, RTC.ConnectorListeners* listeners);

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

def OpenRTM_aist.PublisherFlush.PublisherFlush.write	(	self,
		data,
		sec,
		usec
	)

データを書き込む

Publisher が保持するコンシューマに対してデータを書き込む。コンシューマ、リスナ等が適切に設定されていない等、Publisher オブジェクトが正しく初期化されていない場合、この関数を呼び出すとエラーコード PRECONDITION_NOT_MET が返され、コンシューマへの書き込み等の操作は一切行われない。

コンシューマへの書き込みに対して、コンシューマがフル状態、コンシューマのエラー、コンシューマへの書き込みがタイムアウトした場合にはそれぞれ、エラーコード SEND_FULL, SEND_ERROR, SEND_TIMEOUT が返される。

これら以外のエラーの場合、PORT_ERROR が返される。

引数:

	data	書き込むデータ
	sec	タイムアウト時間
	nsec	タイムアウト時間

戻り値:: PORT_OK 正常終了 PRECONDITION_NO_MET consumer, buffer, listener等が適切に設定されていない等、このオブジェクトの事前条件を満たさない場合。 SEND_FULL 送信先がフル状態 SEND_TIMEOUT 送信先がタイムアウトした CONNECTION_LOST 接続が切断されたことを検知した。

PublisherBase.ReturnCode PublisherFlush.write(const cdrMemoryStream& data, unsigned long sec, unsigned long usec)

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

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

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

クラス OpenRTM_aist.PublisherFlush.PublisherFlush

Public メソッド

説明

メソッド