ErrorResetType.h

[詳解]

/// @file
/// @brief エラーのリセット種別列挙 ErrorResetType のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_ERRORRESETTYPE_H
#define AMDAEMON_ERRORRESETTYPE_H

#include "amdaemon/env.h"

namespace amdaemon
{
/// @addtogroup g_error
/// @{

    /// @brief エラーのリセット種別列挙。
    ///
    /// エラーのリセット方法には下記の3つが存在する。
    ///
    /// - 自動リセット機能
    ///     - 自動リセット機能が有効な場合のみ、下記タイミングでリセットされる。
    ///         - ゲームテストモードの開始および終了時
    ///         - システムテストモードからのアプリ復帰時
    ///         - セガブートからのアプリ復帰時(アプリイメージ更新処理を含む)
    ///     - 自動リセット機能は設定ファイルで有効/無効を設定する必要がある。
    ///         - 通常、ビデオゲームでは有効にする。
    ///         - メダルゲームでは勝手にリセットされないよう無効にする。(作成基準対応)
    ///         - 設定を省略した場合は無効となる。
    /// - Error クラスのメンバ関数 Error#reset 呼び出し
    ///     - 所定の操作を行った際にこの関数を呼び出してエラーをリセットする。
    /// - ボードの電断
    ///     - ボードを電断することでリセットされる。
    ///     - Core クラスのメンバ関数 Core#reboot 呼び出しも電断扱いとなる。
    ///     - アプリやDaemonプロセスを終了させるだけでは電断扱いとはならない。
    ///
    /// この列挙は、上記のうちどの方法でリセット可能なエラーであるかを示す。
    enum class ErrorResetType
    {
        /// 定義しない。または自動解除。
        None = 0,

        /// すべてのエラーリセット方法でリセット可能。
        Any,

        /// ボードの電断でのみリセット可能。
        Shutdown,

        /// Error クラスのメンバ関数 Error#reset 呼び出しでのみリセット可能。
        Operation,

        /// 自動リセット機能、またはボードの電断でリセット可能。
        Test,
    };

    /// @brief エラーリセット種別文字列から @ref ErrorResetType 列挙値を作成する。
    /// @param[in] value エラーリセット種別文字列。
    /// @param[in] defaultType どの種別にも該当しなかった場合の戻り値。
    /// @return @ref ErrorResetType 列挙値。どの種別にも該当しなかった場合は defaultType 。
    /// @see toString(ErrorResetType)
    ErrorResetType makeErrorResetType(
        const wchar_t* value,
        ErrorResetType defaultType = ErrorResetType::Any);

    /// @brief @ref ErrorResetType 列挙値の文字列表現値を取得する。
    /// @param[in] type @ref ErrorResetType 列挙値。
    /// @return @ref ErrorResetType 列挙値の文字列表現値。不正値の場合は nullptr 。
    /// @see makeErrorResetType
    ///
    /// 関数 @ref makeErrorResetType に渡す文字列に対応している。
    const wchar_t* toString(ErrorResetType type);

/// @}
} // namespace amdaemon

#endif // AMDAEMON_ERRORRESETTYPE_H