TestResult.h

[詳解]

/// @file
/// @brief テスト結果列挙 TestResult のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_TESTRESULT_H
#define AMDAEMON_TESTRESULT_H

#include "amdaemon/env.h"

namespace amdaemon
{
/// @addtogroup g_network
/// @{

    /// @brief テスト結果列挙。
    ///
    /// ネットワーク作成基準、メダルバンクリンク作成基準等に従う。
    ///
    /// 関数 toString(TestResult) によって文字列表現値を取得できる。
    enum class TestResult
    {
        None = 0,   ///< 結果無し。未完了や非対応の場合等。
        NA,         ///< "N/A"
        Good,       ///< "GOOD"
        Bad,        ///< "BAD"
    };

    /// @brief @ref TestResult 列挙値の文字列表現値を取得する。
    /// @param[in] result @ref TestResult 列挙値。
    /// @return
    ///     @ref TestResult 列挙値の文字列表現値。
    ///     TestResult::None の場合は空文字列。不正値の場合は nullptr 。
    /// @internal ライブラリ実装メモ: enumsToString.cpp で実装。
    const wchar_t* toString(TestResult result);

/// @}
} // namespace amdaemon

#endif // AMDAEMON_TESTRESULT_H