NetworkTestItem.h

[詳解]

/// @file
/// @brief ネットワークセルフテスト項目列挙 NetworkTestItem のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_NETWORKTESTITEM_H
#define AMDAEMON_NETWORKTESTITEM_H

#include "amdaemon/env.h"
#include "amdaemon/util/StaticAssert.h"

#include <cstddef>

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

    /// @brief ネットワークセルフテスト項目列挙。
    ///
    /// ネットワーク作成基準に従う。
    /// ただしタイトル固有のネットワークについては関知しない。
    ///
    /// 関数 toString(NetworkTestItem) によって文字列表現値を取得できる。
    enum class NetworkTestItem
    {
        IpAddress = 0,  ///< "IP ADDRESS"
        Gateway,        ///< "GATEWAY"
        LanDns,         ///< "DNS(LAN)"
        Hops,           ///< "HOPS"
        LineType,       ///< "LINE TYPE"
        AllnetAuth,     ///< "ALL.Net AUTHENTICATION"
        Aime,           ///< "Aime"
        EMoney,         ///< "EMONEY"
    };

    /// @brief ネットワークセルフテスト項目数。
    /// @internal ライブラリ実装メモ:
    /// NetworkTestItem::EMoney が最大値であることを前提としている。
    static const std::size_t NetworkTestItemCount =
        static_cast<std::size_t>(NetworkTestItem::EMoney) + 1;

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_NETWORKTESTITEM_H