CTimer.h

[詳解]

//=============================================================================
/// @file
/// タイマクラスヘッダファイル
///
/// タイマクラスヘッダファイルです。
///
/// $Id: CTimer.h 245 2019-03-20 15:03:41Z admin $
/// $Date: 2019-03-21 00:03:41 +0900 (2019/03/21 (木)) $
/// $Author: admin $
///
/// @attention なし

#pragma once
#pragma managed( push, off )

//=============================================================================
// インクルードファイル
#include <CSync.h>

//=============================================================================
// 共通ライブラリ名前空間
namespace LibCommon {
    //=========================================================================
    /// タイマクラス
    ///
    /// タイマクラスです。
    ///
    /// @attention なし
    ///
    class LIB_COMMON_API CTimer: public CSync {
        //=====================================================================
        // 構築子と解体子
    public:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        explicit CTimer() noexcept;

        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param[in] dwTime 待機時間
        /// @return    なし
        /// @attention なし
        ///
        explicit CTimer( DWORD dwTime ) noexcept;

        //---------------------------------------------------------------------
        /// デストラクタ
        ///
        /// デストラクタです。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        virtual ~CTimer() noexcept;

        //=====================================================================
        // インライン公開関数
    public:
        //---------------------------------------------------------------------
        /// タイマセット状態取得関数
        ///
        /// タイマセット状態取得関数です。
        ///
        /// @param     なし
        /// @return    タイマセット状態
        /// -          true  セット状態
        /// -          false 非セット状態
        /// @attention なし
        ///
        inline virtual bool IsSet() const noexcept { return m_bSet; }

        //=====================================================================
        // 公開関数
    public:
        //---------------------------------------------------------------------
        /// クローズ関数
        ///
        /// クローズ関数です。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention オーバライド関数です。
        ///
        virtual void Close() noexcept override;

        //---------------------------------------------------------------------
        /// ウェイト関数
        ///
        /// ウェイト関数です。
        ///
        /// @param[in] dwTime ウェイト時間
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバライド関数です。
        ///
        virtual bool Wait( DWORD dwTime = INFINITE ) noexcept override;

        //---------------------------------------------------------------------
        /// リリース関数
        ///
        /// リリース関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバライド関数です。
        ///
        virtual bool Release() noexcept override;

        //---------------------------------------------------------------------
        /// 作成関数
        ///
        /// 作成関数です。
        ///
        /// @param[in] pszObjectName オブジェクト名
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Create( wchar_t const* pszObjectName = nullptr ) noexcept;

        //---------------------------------------------------------------------
        /// オープン関数
        ///
        /// オープン関数です。
        ///
        /// @param[in] pszObjectName オブジェクト名
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Open( wchar_t const* pszObjectName ) noexcept;

        //---------------------------------------------------------------------
        /// タイマ設定関数
        ///
        /// タイマ設定関数です。
        ///
        /// @param[in] dwTime 待機時間(msec)
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Set( DWORD dwTime ) noexcept;

        //---------------------------------------------------------------------
        /// 100ナノタイマ設定関数
        ///
        /// 100ナノタイマ設定関数です。
        ///
        /// @param[in] llWait      待機時間( 100 nsec )
        /// @param[in] nPeriod     周期時間(   1 msec )
        /// @param[in] pfnCallBack コールバック関数ポインタ
        /// @param[in] lpParam     コールバック関数引数ポインタ
        /// @param[in] bResume     再開フラグ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool SetNano100( LONGLONG llWait, LONG nPeriod = 0, PTIMERAPCROUTINE pfnCallBack = nullptr, LPVOID lpParam = nullptr, bool bResume = false ) noexcept;

        //---------------------------------------------------------------------
        /// タイマ解除関数
        ///
        /// タイマ解除関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Cancel() noexcept;

        //=====================================================================
        // 静的限定公開文字列定数
    protected:
        static wchar_t const* const OBJECT_NAME_EXT; ///< オブジェクト名拡張子

        //=====================================================================
        // 限定公開変数
    protected:
        bool m_bInfinite; ///< 無限待機フラグ
        bool m_bSet;      ///< タイマセットフラグ

        //=====================================================================
        // 削除関数
    private:
        CTimer( CTimer const& ) = delete;
        CTimer& operator=( CTimer const& ) = delete;
    };
}

#pragma managed( pop )