#include <PublisherPeriodic.h>

RTC::PublisherPeriodic の継承関係図

RTC::PublisherPeriodic 連携図

公開型
typedef coil::Mutex	Mutex

typedef coil::Condition< Mutex >	Condition

typedef coil::Guard< coil::Mutex >	Guard

基底クラス RTC::DataPortStatus に属する継承公開型
enum	Enum { PORT_OK = 0, PORT_ERROR, BUFFER_ERROR, BUFFER_FULL, BUFFER_EMPTY, BUFFER_TIMEOUT, SEND_FULL, SEND_TIMEOUT, RECV_EMPTY, RECV_TIMEOUT, INVALID_ARGS, PRECONDITION_NOT_MET, CONNECTION_LOST, UNKNOWN_ERROR }

公開メンバ関数
DATAPORTSTATUS_ENUM	PublisherPeriodic (void)
	コンストラクタ [詳解]

virtual	~PublisherPeriodic (void)
	デストラクタ [詳解]

virtual ReturnCode	init (coil::Properties &prop)
	初期化 [詳解]

virtual ReturnCode	setConsumer (InPortConsumer *consumer)
	InPortコンシューマのセット [詳解]

virtual ReturnCode	setBuffer (CdrBufferBase *buffer)
	バッファのセット [詳解]

virtual ReturnCode	setListener (ConnectorInfo &info, ConnectorListeners *listeners)
	リスナを設定する。 [詳解]

virtual ReturnCode	write (cdrMemoryStream &data, unsigned long sec, unsigned long usec)
	データを書き込む [詳解]

virtual bool	isActive ()
	アクティブ化確認 [詳解]

virtual ReturnCode	activate ()
	アクティブ化する [詳解]

virtual ReturnCode	deactivate ()
	非アクティブ化する [詳解]

virtual int	svc (void)
	スレッド実行関数 [詳解]

基底クラス RTC::PublisherBase に属する継承公開メンバ関数
virtual DATAPORTSTATUS_ENUM	~PublisherBase (void)
	デストラクタ [詳解]

virtual void	release ()
	Publisher を破棄する。 [詳解]

限定公開型
enum	Policy { ALL, FIFO, SKIP, NEW }

限定公開メンバ関数
void	setPushPolicy (const coil::Properties &prop)
	PushPolicy の設定 [詳解]

bool	createTask (const coil::Properties &prop)
	Task の設定 [詳解]

ReturnCode	pushAll ()
	push "all" policy [詳解]

ReturnCode	pushFifo ()
	push "fifo" policy [詳解]

ReturnCode	pushSkip ()
	push "skip" policy [詳解]

ReturnCode	pushNew ()
	push "new" policy [詳解]

ReturnCode	convertReturn (BufferStatus::Enum status, cdrMemoryStream &data)
	BufferStatus から DataPortStatus への変換 [詳解]

ReturnCode	invokeListener (DataPortStatus::Enum status, cdrMemoryStream &data)
	DataPortStatusに従ってリスナへ通知する関数を呼び出す。 [詳解]

void	onBufferWrite (cdrMemoryStream &data)
	ON_BUFFER_WRITEのリスナへ通知する。 [詳解]

void	onBufferFull (cdrMemoryStream &data)
	ON_BUFFER_FULLリスナへイベントを通知する。 [詳解]

void	onBufferWriteTimeout (cdrMemoryStream &data)
	ON_BUFFER_WRITE_TIMEOUTのリスナへ通知する。 [詳解]

void	onBufferRead (cdrMemoryStream &data)
	ON_BUFFER_READのリスナへ通知する。 [詳解]

void	onSend (cdrMemoryStream &data)
	ON_SENDのリスナへ通知する。 [詳解]

void	onReceived (cdrMemoryStream &data)
	ON_RECEIVEDのリスナへ通知する。 [詳解]

void	onReceiverFull (cdrMemoryStream &data)
	ON_RECEIVER_FULLのリスナへ通知する。 [詳解]

void	onReceiverTimeout (cdrMemoryStream &data)
	ON_RECEIVER_TIMEOUTのリスナへ通知する。 [詳解]

void	onReceiverError (cdrMemoryStream &data)
	ON_RECEIVER_ERRORのリスナへ通知する。 [詳解]

void	onBufferEmpty ()
	ON_BUFFER_EMPTYのリスナへ通知する。 [詳解]

void	onSenderEmpty ()
	ON_SENDER_EMPTYのリスナへ通知する。 [詳解]

void	onSenderError ()
	ON_SENDER_ERRORのリスナへ通知する。 [詳解]

その他の継承メンバ
基底クラス RTC::DataPortStatus に属する継承静的公開メンバ関数
static const char *	toString (DataPortStatus::Enum status)
	DataPortStatus リターンコードを文字列に変換 [詳解]

詳解

PublisherPeriodic クラス

周期的にデータを送信するための Publisher クラス。このクラスは、通常 Connector 内にあって、バッファおよびコンシューマに関連付けられる。一定周期ごとにバッファからデータを取り出しコンシューマに対してデータを送出する。

型定義メンバ詳解

◆ Condition

typedef coil::Condition<Mutex> RTC::PublisherPeriodic::Condition

◆ Guard

typedef coil::Guard<coil::Mutex> RTC::PublisherPeriodic::Guard

◆ Mutex

typedef coil::Mutex RTC::PublisherPeriodic::Mutex

列挙型メンバ詳解

◆ Policy

enum RTC::PublisherPeriodic::Policy

protected

列挙値
ALL
FIFO
SKIP
NEW

構築子と解体子

◆ PublisherPeriodic()

DATAPORTSTATUS_ENUM RTC::PublisherPeriodic::PublisherPeriodic ( void )

コンストラクタ

◆ ~PublisherPeriodic()

virtual RTC::PublisherPeriodic::~PublisherPeriodic ( void )

virtual

デストラクタ

関数詳解

◆ activate()

virtual ReturnCode RTC::PublisherPeriodic::activate ( )

virtual

アクティブ化する

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

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

RTC::PublisherBaseを実装しています。

◆ convertReturn()

ReturnCode RTC::PublisherPeriodic::convertReturn	(	BufferStatus::Enum	status,
		cdrMemoryStream &	data
	)

protected

BufferStatus から DataPortStatus への変換

バッファからの戻り値を DataPortStatus::Enum 型へ変換する関数。それぞれ、以下のように変換される。変換時にコールバックを呼ぶ場合、コールバク関数も付記する。

BUFFER_OK: PORT_OK
- None
BUFFER_ERROR: BUFFER_ERROR
- None
BUFFER_FULL: BUFFER_FULL
- onBufferFull()
NOT_SUPPORTED: PORT_ERROR
- None
TIMEOUT: BUFFER_TIMEOUT
- onBufferWriteTimeout()
PRECONDITION_NOT_MET: PRECONDITION_NOT_MET
- None
other: PORT_ERROR
- None

引数

status	BufferStatus
data	cdrMemoryStream

戻り値: DataPortStatu 型のリターンコード

◆ createTask()

bool RTC::PublisherPeriodic::createTask ( const coil::Properties & prop )

protected

Task の設定

◆ deactivate()

virtual ReturnCode RTC::PublisherPeriodic::deactivate ( )

virtual

非アクティブ化する

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

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

RTC::PublisherBaseを実装しています。

◆ init()

virtual ReturnCode RTC::PublisherPeriodic::init ( coil::Properties & prop )

virtual

初期化

このクラスのオブジェクトを使用するのに先立ち、必ずこの関数を呼び出す必要がある。引数には、このオブジェクトの各種設定情報を含む Properties を与える。少なくとも、送出処理の呼び出し周期を単位 Hz の数値として Propertyオブジェクトの publisher.push_rate をキーとする要素に設定する必要がある。周期 5ms すなわち、200Hzの場合、 200.0 を設定する。 dataport.publisher.push_rate が未設定の場合、 false が返される。データをプッシュする際のポリシーとして publisher.push_policy をキーとする値に、all, fifo, skip, new のいずれかを与えることができる。

以下のオプションを与えることができる。

publisher.thread_type: スレッドのタイプ (文字列、デフォルト: default)
publisher.push_rate: Publisherの送信周期 (数値)
publisher.push_policy: Pushポリシー (all, fifo, skip, new)
publisher.skip_count: 上記ポリシが skip のときのスキップ数
measurement.exec_time: タスク実行時間計測 (enable/disable)
measurement.exec_count: タスク関数実行時間計測周期 (数値, 回数)
measurement.period_time: タスク周期時間計測 (enable/disable)
measurement.period_count: タスク周期時間計測周期 (数値, 回数)

引数

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

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

RTC::PublisherBaseを実装しています。

◆ invokeListener()

ReturnCode RTC::PublisherPeriodic::invokeListener	(	DataPortStatus::Enum	status,
		cdrMemoryStream &	data
	)

protected

DataPortStatusに従ってリスナへ通知する関数を呼び出す。

引数

status	DataPortStatus
data	cdrMemoryStream

戻り値: リターンコード

◆ isActive()

virtual bool RTC::PublisherPeriodic::isActive ( )

virtual

アクティブ化確認

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

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

RTC::PublisherBaseを実装しています。

◆ onBufferEmpty()

void RTC::PublisherPeriodic::onBufferEmpty ( )

inlineprotected

ON_BUFFER_EMPTYのリスナへ通知する。

参照先 RTC::ON_BUFFER_EMPTY.

◆ onBufferFull()

void RTC::PublisherPeriodic::onBufferFull ( cdrMemoryStream & data )

inlineprotected

ON_BUFFER_FULLリスナへイベントを通知する。

引数

data	cdrMemoryStream

参照先 RTC::ON_BUFFER_FULL.

◆ onBufferRead()

void RTC::PublisherPeriodic::onBufferRead ( cdrMemoryStream & data )

inlineprotected

ON_BUFFER_READのリスナへ通知する。

引数

data	cdrMemoryStream

参照先 RTC::ON_BUFFER_READ.

◆ onBufferWrite()

void RTC::PublisherPeriodic::onBufferWrite ( cdrMemoryStream & data )

inlineprotected

ON_BUFFER_WRITEのリスナへ通知する。

引数

data	cdrMemoryStream

参照先 RTC::ON_BUFFER_WRITE.

◆ onBufferWriteTimeout()

void RTC::PublisherPeriodic::onBufferWriteTimeout ( cdrMemoryStream & data )

inlineprotected

ON_BUFFER_WRITE_TIMEOUTのリスナへ通知する。

引数

data	cdrMemoryStream

参照先 RTC::ON_BUFFER_WRITE_TIMEOUT.

◆ onReceived()

void RTC::PublisherPeriodic::onReceived ( cdrMemoryStream & data )

inlineprotected

ON_RECEIVEDのリスナへ通知する。

引数

data	cdrMemoryStream

参照先 RTC::ON_RECEIVED.

◆ onReceiverError()

void RTC::PublisherPeriodic::onReceiverError ( cdrMemoryStream & data )

inlineprotected

ON_RECEIVER_ERRORのリスナへ通知する。

引数

data	cdrMemoryStream

参照先 RTC::ON_RECEIVER_ERROR.

◆ onReceiverFull()

void RTC::PublisherPeriodic::onReceiverFull ( cdrMemoryStream & data )

inlineprotected

ON_RECEIVER_FULLのリスナへ通知する。

引数

data	cdrMemoryStream

参照先 RTC::ON_RECEIVER_FULL.

◆ onReceiverTimeout()

void RTC::PublisherPeriodic::onReceiverTimeout ( cdrMemoryStream & data )

inlineprotected

ON_RECEIVER_TIMEOUTのリスナへ通知する。

引数

data	cdrMemoryStream

参照先 RTC::ON_RECEIVER_TIMEOUT.

◆ onSend()

void RTC::PublisherPeriodic::onSend ( cdrMemoryStream & data )

inlineprotected

ON_SENDのリスナへ通知する。

引数

data	cdrMemoryStream

参照先 RTC::ON_SEND.

◆ onSenderEmpty()

void RTC::PublisherPeriodic::onSenderEmpty ( )

inlineprotected

ON_SENDER_EMPTYのリスナへ通知する。

参照先 RTC::ON_SENDER_EMPTY.

◆ onSenderError()

void RTC::PublisherPeriodic::onSenderError ( )

inlineprotected

ON_SENDER_ERRORのリスナへ通知する。

参照先 DLL_EXPORT, RTC::ON_SENDER_ERROR, PublisherPeriodicInit(), RTC_DEBUG.

◆ pushAll()

ReturnCode RTC::PublisherPeriodic::pushAll ( )

protected

push "all" policy

◆ pushFifo()

ReturnCode RTC::PublisherPeriodic::pushFifo ( )

protected

push "fifo" policy

◆ pushNew()

ReturnCode RTC::PublisherPeriodic::pushNew ( )

protected

push "new" policy

◆ pushSkip()

ReturnCode RTC::PublisherPeriodic::pushSkip ( )

protected

push "skip" policy

◆ setBuffer()

virtual ReturnCode RTC::PublisherPeriodic::setBuffer ( CdrBufferBase * buffer )

virtual

バッファのセット

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

引数

buffer CDR buffer へのポインタ

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

RTC::PublisherBaseを実装しています。

◆ setConsumer()

virtual ReturnCode RTC::PublisherPeriodic::setConsumer ( InPortConsumer * consumer )

virtual

InPortコンシューマのセット

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

引数

consumer Consumer へのポインタ

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

RTC::PublisherBaseを実装しています。

◆ setListener()

virtual ReturnCode RTC::PublisherPeriodic::setListener	(	ConnectorInfo &	info,
		ConnectorListeners *	listeners
	)

virtual

リスナを設定する。

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

引数

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

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

RTC::PublisherBaseを実装しています。

◆ setPushPolicy()

void RTC::PublisherPeriodic::setPushPolicy ( const coil::Properties & prop )

protected

PushPolicy の設定

◆ svc()

virtual int RTC::PublisherPeriodic::svc ( void )

virtual

スレッド実行関数

coil::PeriodicTask により周期実行されるタスク実行関数。

◆ write()

virtual ReturnCode RTC::PublisherPeriodic::write	(	cdrMemoryStream &	data,
		unsigned long	sec,
		unsigned long	usec
	)

virtual

データを書き込む

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

バッファへの書き込みと、InPortへのデータの送信は非同期的に行われるため、この関数は、InPortへのデータ送信の結果を示す、 CONNECTION_LOST, BUFFER_FULL などのリターンコードを返すことがある。この場合、データのバッファへの書き込みは行われない。

バッファへの書き込みに対して、バッファがフル状態、バッファのエラー、バッファへの書き込みがタイムアウトした場合、バッファの事前条件が満たされない場合にはそれぞれ、エラーコード BUFFER_FULL, BUFFER_ERROR, BUFFER_TIMEOUT, PRECONDITION_NOT_MET が返される。

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

引数

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

戻り値: PORT_OK 正常終了 PRECONDITION_NO_MET consumer, buffer, listener等が適切に設定されていない等、このオブジェクトの事前条件を満たさない場合。 CONNECTION_LOST 接続が切断されたことを検知した。 BUFFER_FULL バッファがフル状態である。 BUFFER_ERROR バッファに何らかのエラーが生じた場合。 NOT_SUPPORTED サポートされない操作が行われた。 TIMEOUT タイムアウトした。

RTC::PublisherBaseを実装しています。

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

PublisherPeriodic.h

公開型

公開メンバ関数

限定公開型

限定公開メンバ関数

その他の継承メンバ

詳解

型定義メンバ詳解

◆ Condition

◆ Guard

◆ Mutex

列挙型メンバ詳解

◆ Policy

構築子と解体子

◆ PublisherPeriodic()

◆ ~PublisherPeriodic()

関数詳解

◆ activate()

◆ convertReturn()

◆ createTask()

◆ deactivate()

◆ init()

◆ invokeListener()

◆ isActive()

◆ onBufferEmpty()

◆ onBufferFull()

◆ onBufferRead()

◆ onBufferWrite()

◆ onBufferWriteTimeout()

◆ onReceived()

◆ onReceiverError()

◆ onReceiverFull()

◆ onReceiverTimeout()

◆ onSend()

◆ onSenderEmpty()

◆ onSenderError()

◆ pushAll()

◆ pushFifo()

◆ pushNew()

◆ pushSkip()

◆ setBuffer()

◆ setConsumer()

◆ setListener()

◆ setPushPolicy()

◆ svc()

◆ write()