CEvent.h

[詳解]

//=============================================================================
/// @file
/// イベントクラスヘッダファイル
///
/// イベントクラスヘッダファイルです。
///
/// $Id: CEvent.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 CEvent: public CSync {
        //=====================================================================
        // 構築子と解体子
    public:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        explicit CEvent() noexcept;

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

        //=====================================================================
        // 公開関数
    public:
        //---------------------------------------------------------------------
        /// リリース関数
        ///
        /// リリース関数です。
        ///
        /// @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] bManual       手動モードフラグ
        /// @param[in] bState        初期状態
        /// @param[in] pszObjectName オブジェクト名
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Create( bool bManual, bool bState, wchar_t const* pszObjectName = nullptr ) noexcept;

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

        //---------------------------------------------------------------------
        /// シグナルセット関数
        ///
        /// シグナルセット関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Set() noexcept;

        //---------------------------------------------------------------------
        /// シグナルリセット関数
        ///
        /// シグナルリセット関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Reset() noexcept;

        //---------------------------------------------------------------------
        /// シグナルパルス関数
        ///
        /// シグナルパルス関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Pulse() noexcept;

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

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

#pragma managed( pop )