AppTest.h

[詳解]

/// @file
/// テストアプリケーションヘッダファイル
///
/// テストアプリケーションヘッダファイルです。
///
/// $Id: AppTest.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 <AppTestDef.h>
#include <CWndMain.h>
#include <CAppTestMenu.h>
#include <CJsonConfig.h>
#include <LibUtility.h>

//=============================================================================
// テストアプリケーション名前空間
namespace AppTest {
    //=========================================================================
    /// テストアプリケーションクラス
    ///
    /// テストアプリケーションクラスです。
    ///
    /// @attention シングルトンクラスです。
    ///
    class CAppTest final: public CWndMain {
        //=====================================================================
        // 構築子と解体子
    protected:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        explicit CAppTest() noexcept;

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

        //=====================================================================
        // インライン公開関数
    public:
        //---------------------------------------------------------------------
        /// セクション名取得関数
        ///
        /// セクション名取得関数です。
        ///
        /// @param     なし
        /// @return    文字列ポインタ
        /// @attention オーバライド関数です。
        ///
        inline virtual wchar_t const* GetSectionName() const noexcept override { return L"テストアプリケーション"; }

        //=====================================================================
        // 公開関数
    public:
        //---------------------------------------------------------------------
        /// 各種メッセージ処理関数
        ///
        /// 各種メッセージ処理関数です。
        ///
        /// @param     なし
        /// @return    メッセージ終了コード
        /// @attention オーバライド関数です。
        ///
        virtual LRESULT WmClose() noexcept override;

        //---------------------------------------------------------------------
        /// アイドル処理コールバック関数
        ///
        /// アイドル処理コールバック関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention オーバライド関数です。
        ///
        virtual bool IdleCallBackProc() noexcept override;

        //---------------------------------------------------------------------
        /// アプリケーション初期化関数
        ///
        /// アプリケーション初期化関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool InitApp() noexcept;

        //---------------------------------------------------------------------
        /// アプリケーション実行関数
        ///
        /// アプリケーション実行関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool ExecApp() noexcept;

        //---------------------------------------------------------------------
        /// アプリケーション終了関数
        ///
        /// アプリケーション終了関数です。
        ///
        /// @param[in] bResult 直前の実行結果
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool FinishApp( bool bResult ) noexcept;

        //---------------------------------------------------------------------
        /// コンソール構成情報復元関数
        ///
        /// コンソール構成情報復元関数です。
        ///
        /// @param[in] rcConfig JSON構成ファイル参照
        /// @param[in] ePos     ウィンドウ初期配置位置種別
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool ResumeConfigConsole( CJsonConfig& rcConfig, EWindowPosition ePos ) noexcept;

        //---------------------------------------------------------------------
        /// コンソール構成情報保存関数
        ///
        /// コンソール構成情報保存関数です。
        ///
        /// @param[in] rcConfig JSON構成ファイル参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool SaveConfigConsole( CJsonConfig& rcConfig ) noexcept;

        //---------------------------------------------------------------------
        /// ウィンドウ構成情報復元関数
        ///
        /// ウィンドウ構成情報復元関数です。
        ///
        /// @param[in] rcConfig JSON構成ファイル参照
        /// @param[in] ePos     ウィンドウ初期配置位置種別
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool ResumeConfigWindow( CJsonConfig& rcConfig, EWindowPosition ePos ) noexcept;

        //---------------------------------------------------------------------
        /// ウィンドウ構成情報保存関数
        ///
        /// ウィンドウ構成情報保存関数です。
        ///
        /// @param[in] rcConfig JSON構成ファイル参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool SaveConfigWindow( CJsonConfig& rcConfig ) noexcept;

        //=====================================================================
        // インライン静的公開関数
    public:
        //---------------------------------------------------------------------
        /// インスタンス取得関数
        ///
        /// インスタンス取得関数です。
        ///
        /// @param     なし
        /// @return    インスタンス参照
        /// @attention なし
        ///
        inline static CAppTest& GetInstance() noexcept { return s_cInstance; }

        //---------------------------------------------------------------------
        /// 構成ファイルパス取得関数
        ///
        /// 構成ファイルパス取得関数です。
        ///
        /// @param     なし
        /// @return    文字列ポインタ
        /// @attention なし
        ///
        inline static wchar_t const* GetConfigFilePath() noexcept { return _SOLUTION_DIR L"Data\\AppTest.config"; }

        //=====================================================================
        // 静的公開関数
    public:
        //---------------------------------------------------------------------
        /// メイン関数
        ///
        /// メイン関数です。
        ///
        /// @param     なし
        /// @return    終了コード
        /// @attention なし
        ///
        static int Main() noexcept;

        //---------------------------------------------------------------------
        /// 日時文字列取得関数
        ///
        /// 日時文字列取得関数です。
        ///
        /// @param[in]  rsDateTime システム時刻構造体参照
        /// @param[out] rcString   文字列クラス参照
        /// @return     文字列ポインタ
        /// @attention  なし
        ///
        static wchar_t const* GetDateTimeString( SYSTEMTIME const& rsDateTime, CString& rcString = CString()() ) noexcept;

        //=====================================================================
        // 限定公開変数
    protected:
        CJsonConfig  m_cConfig;    ///< JSON構成情報
        CAppTestMenu m_cMainMenu;  ///< テストアプリケーションメインメニュー
        CString      m_cPrevTime;  ///< 前回終了日時文字列
        SYSTEMTIME   m_sStartTime; ///< 開始日時
        SYSTEMTIME   m_sEndTime;   ///< 終了日時

        //=====================================================================
        // 静的公開文字列定数
    public:
        static wchar_t const* const SECTION_CONSOLE;   ///< コンソールセクション文字列
        static wchar_t const* const KEY_PREV_END_TIME; ///< 前回終了日時キー文字列
        static wchar_t const* const KEY_START_TIME;    ///< 開始日時キー文字列
        static wchar_t const* const KEY_END_TIME;      ///< 終了日時キー文字列
        static wchar_t const* const SECTION_WINDOW;    ///< ウィンドウセクション文字列
        static wchar_t const* const SECTION_STATIC;    ///< 静的変数セクション文字列

        //=====================================================================
        // 静的限定公開変数
    protected:
        static CAppTest s_cInstance; ///< 静的インスタンス

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

#pragma managed( pop )