LibCommon::CTimer クラス

タイマクラス [詳解]

#include "CTimer.h"

LibCommon::CTimer の継承関係図

LibCommon::CTimer 連携図

公開メンバ関数
	CTimer () noexcept
	コンストラクタ [詳解]
	CTimer (DWORD dwTime) noexcept
	コンストラクタ [詳解]
virtual	~CTimer () noexcept
	デストラクタ [詳解]
virtual bool	IsSet () const noexcept
	タイマセット状態取得関数 [詳解]
virtual void	Close () noexcept override
	クローズ関数 [詳解]
virtual bool	Wait (DWORD dwTime=INFINITE) noexcept override
	ウェイト関数 [詳解]
virtual bool	Release () noexcept override
	リリース関数 [詳解]
virtual bool	Create (wchar_t const *pszObjectName=nullptr) noexcept
	作成関数 [詳解]
virtual bool	Open (wchar_t const *pszObjectName) noexcept
	オープン関数 [詳解]
virtual bool	Set (DWORD dwTime) noexcept
	タイマ設定関数 [詳解]
virtual bool	SetNano100 (LONGLONG llWait, LONG nPeriod=0, PTIMERAPCROUTINE pfnCallBack=nullptr, LPVOID lpParam=nullptr, bool bResume=false) noexcept
	100ナノタイマ設定関数 [詳解]
virtual bool	Cancel () noexcept
	タイマ解除関数 [詳解]
基底クラス LibCommon::CSync に属する継承公開メンバ関数
	CSync () noexcept
	コンストラクタ [詳解]
virtual	~CSync () noexcept
	デストラクタ [詳解]
virtual HANDLE	GetHandle () const noexcept
	オブジェクトハンドル取得関数 [詳解]
virtual bool	IsCreate () const noexcept
	新規作成状態取得関数 [詳解]
virtual bool	Lock (DWORD dwTime=INFINITE) noexcept
	ロック関数 [詳解]
virtual bool	Unlock () noexcept
	ロック解除関数 [詳解]

限定公開変数類
bool	m_bInfinite
	無限待機フラグ [詳解]
bool	m_bSet
	タイマセットフラグ [詳解]
基底クラス LibCommon::CSync に属する継承限定公開変数類
HANDLE	m_hObject
	オブジェクトハンドル [詳解]
bool	m_bIsCreate
	新規作成フラグ [詳解]

静的限定公開変数類
static wchar_t const *const	OBJECT_NAME_EXT = L".CTimer"
	オブジェクト名拡張子 [詳解]

非公開メンバ関数
	CTimer (CTimer const &)=delete
CTimer &	operator= (CTimer const &)=delete

詳解

タイマクラス

タイマクラスです。

注意

なし

CTimer.h の 30 行目に定義があります。

構築子と解体子

LibCommon::CTimer::CTimer ( )

explicitnoexcept

コンストラクタ

コンストラクタです。

引数

なし

戻り値

なし

注意

なし

CTimer.cpp の 28 行目に定義があります。

        : CSync()
        // メンバ変数初期化
        , m_bInfinite( false )
        , m_bSet( false )
    {}

LibCommon::CTimer::CTimer ( DWORD  dwTime )

explicitnoexcept

コンストラクタ

コンストラクタです。

引数

[in]

dwTime

待機時間

戻り値

なし

注意

なし

CTimer.cpp の 38 行目に定義があります。

参照先 Create(), Set().

        : CTimer()
    {
        // 作成する
        Create();

        // タイマを設定する
        Set( dwTime );
    }

呼び出し関係図:

LibCommon::CTimer::~CTimer ( )

virtualnoexcept

デストラクタ

デストラクタです。

引数

なし

戻り値

なし

注意

なし

CTimer.cpp の 51 行目に定義があります。

参照先 Close().

                             {
        // クローズする
        Close();
    }

呼び出し関係図:

LibCommon::CTimer::CTimer ( CTimer const &  )

privatedelete

関数詳解

virtual bool LibCommon::CTimer::IsSet ( ) const

inlinevirtualnoexcept

タイマセット状態取得関数

タイマセット状態取得関数です。

引数

なし

戻り値

タイマセット状態

• true セット状態
• false 非セット状態

注意

なし

CTimer.h の 81 行目に定義があります。

{ return m_bSet; }

void LibCommon::CTimer::Close ( )

overridevirtualnoexcept

クローズ関数

クローズ関数です。

引数

なし

戻り値

なし

注意

オーバライド関数です。

LibCommon::CSyncを再実装しています。

CTimer.cpp の 60 行目に定義があります。

参照先 LibCommon::CSync::Close(), m_bInfinite, m_bSet.

参照元 Create(), Open(), ~CTimer().

                                {
        // 基底クラスの関数を実行する
        CSync::Close();

        // メンバ変数をクリアする
        m_bInfinite = false;
        m_bSet      = false;
    }

呼び出し関係図:

被呼び出し関係図:

bool LibCommon::CTimer::Wait ( DWORD  dwTime = INFINITE )

overridevirtualnoexcept

ウェイト関数

ウェイト関数です。

引数

[in]

dwTime

ウェイト時間

戻り値

実行結果

• true 成功
• false 失敗

注意

オーバライド関数です。

LibCommon::CSyncを再実装しています。

CTimer.cpp の 71 行目に定義があります。

参照先 m_bInfinite, m_bSet, LibCommon::CSync::Wait().

参照元 LibWindow::CWndMain::EndFrame(), LibCommon::CConsole::InputChar(), LibCommon::CConsole::InputRecord().

                                             {
        // 処理ブロック
        bool result = false;
        do {
            // 無限待機フラグを調べる
            if ( m_bInfinite ) {
                // 失敗！
                break;
            }
            // タイマセットフラグを調べる
            else if ( !m_bSet ) {
                // 失敗！
                break;
            }

            // 同期オブジェクトをウェイトする
            result = CSync::Wait( dwTime );
        } while ( false );

        // 実行結果を返す
        return result;
    }

呼び出し関係図:

被呼び出し関係図:

bool LibCommon::CTimer::Release ( )

overridevirtualnoexcept

リリース関数

リリース関数です。

引数

なし

戻り値

実行結果

• true 成功
• false 失敗

注意

オーバライド関数です。

LibCommon::CSyncを実装しています。

CTimer.cpp の 96 行目に定義があります。

参照先 Cancel().

                                  {
        // タイマを解除する
        return Cancel();
    }

呼び出し関係図:

bool LibCommon::CTimer::Create ( wchar_t const *  pszObjectName = nullptr )

virtualnoexcept

作成関数

作成関数です。

引数

[in]

pszObjectName

オブジェクト名

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

CTimer.cpp の 103 行目に定義があります。

参照先 Close(), LibCommon::CSync::m_bIsCreate, LibCommon::CSync::m_hObject, OBJECT_NAME_EXT.

参照元 CTimer(), LibWindow::CWndMain::InitFrame().

                                                               {
        // 処理ブロック
        bool result = false;
        do {
            // タイマハンドルを調べる
            if ( nullptr != m_hObject ) {
                // クローズする
                Close();
            }

            // オブジェクト名を調べる
            wchar_t szBuffer[ MAX_PATH ];
            if ( nullptr != pszObjectName ) {
                // オブジェクト名に拡張子を追加する
                ::wcscpy_s( szBuffer, pszObjectName );
                ::wcscat_s( szBuffer, OBJECT_NAME_EXT );
                pszObjectName = szBuffer;
            }

            // タイマを作成する
            m_hObject = ::CreateWaitableTimerW( nullptr, false, pszObjectName );
            if ( nullptr == m_hObject ) {
                // 失敗！
                break;
            }
            // エラーコードを調べる
            else if ( ERROR_ALREADY_EXISTS != ::GetLastError() ) {
                // 新規作成フラグをセットする
                m_bIsCreate = true;
            }

            // 成功！
            result = true;
        } while ( false );

        // 実行結果を返す
        return result;
    }

呼び出し関係図:

被呼び出し関係図:

bool LibCommon::CTimer::Open ( wchar_t const *  pszObjectName )

virtualnoexcept

オープン関数

オープン関数です。

引数

[in]

pszObjectName

オブジェクト名

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

CTimer.cpp の 144 行目に定義があります。

参照先 Close(), LibCommon::CSync::m_hObject, OBJECT_NAME_EXT.

                                                             {
        // 処理ブロック
        bool result = false;
        do {
            // オブジェクト名を調べる
            if ( nullptr == pszObjectName ) {
                // 失敗！
                break;
            }
            // タイマハンドルを調べる
            else if ( nullptr != m_hObject ) {
                // クローズする
                Close();
            }

            // オブジェクト名に拡張子を追加する
            wchar_t szBuffer[ MAX_PATH ];
            ::wcscpy_s( szBuffer, pszObjectName );
            ::wcscat_s( szBuffer, OBJECT_NAME_EXT );
            pszObjectName = szBuffer;

            // タイマをオープンする
            m_hObject = ::OpenWaitableTimerW( TIMER_ALL_ACCESS, false, pszObjectName );
            if ( nullptr == m_hObject ) {
                // 失敗！
                break;
            }

            // 成功！
            result = true;
        } while ( false );

        // 実行結果を返す
        return result;
    }

呼び出し関係図:

bool LibCommon::CTimer::Set ( DWORD  dwTime )

virtualnoexcept

タイマ設定関数

タイマ設定関数です。

引数

[in]

dwTime

待機時間(msec)

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

CTimer.cpp の 182 行目に定義があります。

参照先 Cancel(), m_bInfinite, m_bSet, LibCommon::CSync::m_hObject, SetNano100().

参照元 CTimer().

                                            {
        // 処理ブロック
        bool result = false;
        do {
            // タイマハンドルを調べる
            if ( nullptr == m_hObject ) {
                // 失敗！
                break;
            }
            // タイマセットフラグを調べる
            else if ( m_bSet ) {
                // タイマをキャンセルする
                Cancel();
            }

            // 待機時間を調べる
            if ( INFINITE == dwTime ) {
                // 無限待機フラグをセットする
                m_bInfinite = true;

                // 成功！
                result = true;
                break;
            }

            // 100ナノタイマを設定する
            LONGLONG llWait = ( -10LL * 1000 * dwTime );
            result = SetNano100( llWait );
        } while ( false );

        // 実行結果を返す
        return result;
    }

呼び出し関係図:

被呼び出し関係図:

bool LibCommon::CTimer::SetNano100 ( LONGLONG  llWait, LONG  nPeriod = 0, PTIMERAPCROUTINE  pfnCallBack = nullptr, LPVOID  lpParam = nullptr, bool  bResume = false  )

virtualnoexcept

100ナノタイマ設定関数

100ナノタイマ設定関数です。

引数

[in]	llWait	待機時間( 100 nsec )
[in]	nPeriod	周期時間( 1 msec )
[in]	pfnCallBack	コールバック関数ポインタ
[in]	lpParam	コールバック関数引数ポインタ
[in]	bResume	再開フラグ

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

CTimer.cpp の 218 行目に定義があります。

参照先 m_bInfinite, m_bSet, LibCommon::CSync::m_hObject.

参照元 Set(), LibWindow::CWndMain::StartFrame().

                                                                                                                                {
        // 処理ブロック
        bool result = false;
        do {
            // 無限待機フラグをクリアする
            m_bInfinite = false;

            // タイマをアクティブにする
            LARGE_INTEGER sDueTime;
            sDueTime.QuadPart = llWait;
            if ( 0 == ::SetWaitableTimer( m_hObject, &sDueTime, nPeriod, pfnCallBack, lpParam, bResume ) ) {
                // 失敗！
                break;
            }
            // 再開フラグを調べる
            else if ( bResume ) {
                // ラストエラーを調べる
                if ( ERROR_NOT_SUPPORTED == ::GetLastError() ) {
                    // タイマをキャンセルする
                    ::CancelWaitableTimer( m_hObject );

                    // 失敗！
                    break;
                }
            }

            // タイマセットフラグをセットする
            m_bSet = true;

            // 成功！
            result = true;
        } while ( false );

        // 実行結果を返す
        return result;
    }

被呼び出し関係図:

bool LibCommon::CTimer::Cancel ( )

virtualnoexcept

タイマ解除関数

タイマ解除関数です。

引数

なし

戻り値

実行結果

• true 成功
• false 失敗

注意

なし

CTimer.cpp の 257 行目に定義があります。

参照先 m_bInfinite, m_bSet, LibCommon::CSync::m_hObject, OBJECT_NAME_EXT.

参照元 Release(), Set().

                                 {
        // 処理ブロック
        bool result = false;
        do {
            // 無限待機フラグを調べる
            if ( m_bInfinite ) {
                // 無限待機フラグをクリアする
                m_bInfinite = false;
            }
            // タイマセットフラグを調べる
            else if ( m_bSet ) {
                // タイマをキャンセルする
                if ( 0 == ::CancelWaitableTimer( m_hObject ) ) {
                    // 失敗！
                    break;
                }

                // タイマセットフラグをクリアする
                m_bSet = false;
            }

            // 成功！
            result = true;
        } while ( false );

        // 実行結果を返す
        return result;
    }

被呼び出し関係図:

CTimer& LibCommon::CTimer::operator= ( CTimer const &  )

privatedelete

メンバ詳解

wchar_t const *const LibCommon::CTimer::OBJECT_NAME_EXT = L".CTimer"

staticprotected

オブジェクト名拡張子

CTimer.h の 195 行目に定義があります。

参照元 Cancel(), Create(), Open().

bool LibCommon::CTimer::m_bInfinite

protected

無限待機フラグ

CTimer.h の 200 行目に定義があります。

参照元 Cancel(), Close(), Set(), SetNano100(), Wait().

bool LibCommon::CTimer::m_bSet

protected

タイマセットフラグ

CTimer.h の 201 行目に定義があります。

参照元 Cancel(), Close(), Set(), SetNano100(), Wait().

---

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

• C:/Work/VisualStudio2017/Solution46/Include/Library/LibCommon/CTimer.h
• C:/Work/VisualStudio2017/Solution46/Source/Library/LibCommon/CTimer.cpp