alt::WatchDogTimer クラス

タイマーに関するWindowsAPIを集約したクラス [詳解]

#include <WatchDogTimer.h>

alt::WatchDogTimer の継承関係図

公開メンバ関数
APIENTRY	WatchDogTimer (skeleton::ITimeup *timeup, UINT uPeriod=1)
	コンストラクタ
APIENTRY	WatchDogTimer (UINT uPeriod=1)
	コンストラクタ
APIENTRY	~WatchDogTimer ()
	デストラクタ
BOOL APIENTRY	InitTimer (LPCTSTR lpctszName=NULL)
	初期化
BOOL APIENTRY	StartTimer (DWORD dwTime) const
	タイマー開始
BOOL APIENTRY	StopTimer () const
	タイマー停止
DWORD APIENTRY	WaitTimer () const
	タイムアップ待機
基底クラス alt::WaitableHandleLibrary に属する継承公開メンバ関数
DWORD APIENTRY	Wait (DWORD dwWaitTime=INFINITE) const
	シグナル状態になるとブロックを解除します。
基底クラス alt::HandleLibrary に属する継承公開メンバ関数
APIENTRY	HandleLibrary ()
	コンストラクタ
APIENTRY	~HandleLibrary ()
	デストラクタ
BOOL APIENTRY	Close ()
	使用しなくなったハンドルはこれでクローズします。
HANDLE APIENTRY	GetHandle () const
	継承先はこの関数でハンドルを取得します。
基底クラス alt::WindowsLibrary に属する継承公開メンバ関数
APIENTRY	WindowsLibrary ()
	コンストラクタ
virtual APIENTRY	~WindowsLibrary ()
	デストラクタ
virtual DWORD APIENTRY	GetErrNo () const
	WindowsAPIのエラー値を取得します。
virtual VOID APIENTRY	SetErrNo ()
	WINAPIエラーの情報を設定します。

非公開変数類
skeleton::ITimeup *	_timeup
	コールバック関数を定義したクラス
UINT	_uPeriod

その他の継承メンバ
基底クラス alt::HandleLibrary に属する継承限定公開変数類
HANDLE	_hObject
	ハンドルを使用するWindowsAPIで保持するHANDLE値
基底クラス alt::WindowsLibrary に属する継承限定公開変数類
DWORD	_dwErrorNo

詳解

タイマーに関するWindowsAPIを集約したクラス

WatchDogTimer.h の 17 行目に定義があります。

構築子と解体子

WatchDogTimer() [1/2]

WatchDogTimer::WatchDogTimer

(

UINT

uPeriod = 1

)

コンストラクタ

引数

[in]

uPeriod

分解能 for timeBeginPeriod()

覚え書き

時間になると、イベントで通知します。

WatchDogTimer.cpp の 12 行目に定義があります。

参照先 _timeup, _uPeriod.

WatchDogTimer() [2/2]

WatchDogTimer::WatchDogTimer	(	skeleton::ITimeup *	timeup,
		UINT	uPeriod = 1
	)

コンストラクタ

引数

[in]	timeup	時間になると、timeupコールバックで通知します。
[in]	uPeriod	分解能 for timeBeginPeriod()

WatchDogTimer.cpp の 18 行目に定義があります。

参照先 _timeup, _uPeriod.

~WatchDogTimer()

WatchDogTimer::~WatchDogTimer

(

)

デストラクタ

WatchDogTimer.cpp の 24 行目に定義があります。

参照先 _uPeriod.

関数詳解

InitTimer()

BOOL WatchDogTimer::InitTimer

(

LPCTSTR

lpctszName = NULL

)

初期化

引数

lpctszName

タイマーの名称

戻り値

BOOL

戻り値

TRUE(成功)
FALSE(失敗)

WatchDogTimer.cpp の 29 行目に定義があります。

参照先 alt::HandleLibrary::_hObject, _uPeriod.

参照元 alt::FactoryMethod::ClockElement::Init().

StartTimer()

BOOL WatchDogTimer::StartTimer

(

DWORD

dwTime

)

const

タイマー開始

引数

dwTime

タイマーインターバル

戻り値

BOOL

戻り値

TRUE(成功)
FALSE(失敗)

WatchDogTimer.cpp の 44 行目に定義があります。

参照先 alt::HandleLibrary::_hObject, _timeup, alt::skeleton::ITimeup::TimeupCall().

参照元 alt::FactoryMethod::ClockElement::Invoke().

StopTimer()

BOOL WatchDogTimer::StopTimer

(

)

const

タイマー停止

戻り値

BOOL

戻り値

TRUE(成功)
FALSE(失敗)

WatchDogTimer.cpp の 68 行目に定義があります。

参照先 alt::HandleLibrary::_hObject.

参照元 alt::FactoryMethod::ClockElement::Stop().

WaitTimer()

DWORD WatchDogTimer::WaitTimer

(

)

const

タイムアップ待機

戻り値

DWORD

戻り値

WAIT_OBJECT_O

タイムアップによるブレイク

WatchDogTimer.cpp の 63 行目に定義があります。

参照先 alt::HandleLibrary::_hObject.

参照元 alt::FactoryMethod::ClockElement::Invoke().

メンバ詳解

_timeup

skeleton::ITimeup* alt::WatchDogTimer::_timeup

private

コールバック関数を定義したクラス

WatchDogTimer.h の 60 行目に定義があります。

参照元 WatchDogTimer(), StartTimer().

_uPeriod

UINT alt::WatchDogTimer::_uPeriod

private

WatchDogTimer.h の 61 行目に定義があります。

参照元 WatchDogTimer(), ~WatchDogTimer(), InitTimer().

---

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

• C:/Users/masah/source/repos/KumaKuma0421/Alternate/WindowsLibrary/WatchDogTimer.h
• C:/Users/masah/source/repos/KumaKuma0421/Alternate/WindowsLibrary/WatchDogTimer.cpp