クラス Sapie::CTimerController

タイマー制御クラス [詳細]

#include <TimerController.h>

Sapie::CTimerControllerに対する継承グラフ


Public メソッド
	CTimerController ()
	コンストラクタ
virtual	~CTimerController ()
	デストラクタ
long	SetTimer (unsigned long interval, unsigned long count)
	タイマを開始する。
long	CancelTimer (long reqIDNo)
	タイマをキャンセルする。

説明

タイマー制御クラス

指定された周期で定期的にイベント発生させる機能を提供する。

タイマの設定は SetTimer() メソッドを用いる。 SetTimer メソッドを呼び出した時点から、指定された周期で指定された回数タイマイベントが発生する。

タイマの実行を途中で中断する場合には、 CancelTimer() メソッドを用いる。これを呼び出した時点でタイマの実行は終了し、タイマイベントはその後発生しない。

なお、本クラスを利用したタイマの精度は10ミリ秒程度である。周期として10ミリ秒以下の値を指定しても 10ミリ秒以下の間隔でイベントが発生することはなく、イベントの発生間隔は、最大10ミリ秒程度の誤差を含む。

本クラスのメソッドの処理で何らかの異常があった場合には、そのエラーの内容を GetErrorCode() メソッドで取得する。

long Sapie::CTimerController::SetTimer	(	unsigned long	interval,
		unsigned long	count
	)

タイマを開始する。

本メソッドをコールすることによりタイマが開始される。引数として指定した周期ごとに、指定した回数タイマイベントが発生する。

本メソッドを複数回呼び出した場合は、呼び出した回数だけタイマがスタートする。本メソッドの呼び出しと、タイマイベントを紐付けるために、要求識別番号が利用できる。本メソッドの戻り値として返された要求識別番号と同じ番号が OnTimerイベントの引数として渡される。

引数:

`[in]`	interval	タイマーの間隔(ミリ秒）
`[in]`	count	タイマイベントが発生する回数。0を指定すると無限回。

long Sapie::CTimerController::CancelTimer ( long reqIDNo )

タイマをキャンセルする。

SetTimer メソッドで指定したイベント回数を待つことなく、タイマの実行を中止したい場合に本メソッドを使用する。引数として渡された要求識別番号に対応するタイマを停止する。要求識別番号に0を指定した場合には全てのタイマを停止する。

引数:

[in] reqIDNo 停止するタイマの要求識別番号。0を指定した場合には、全てのタイマを停止する。

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