WiFiUnit.h

[詳解]

/// @file
/// @brief ALL.Net Wi-Fi ルータの情報を提供するクラス WiFiUnit のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_ALLNET_WIFIUNIT_H
#define AMDAEMON_ALLNET_WIFIUNIT_H

#include "amdaemon/env.h"

#include <cstddef>

// 内部クラスの前方宣言
namespace amdaemon { class InnerIndexHolder; }

namespace amdaemon
{
namespace allnet
{
/// @addtogroup g_allnet
/// @{

    /// @brief ALL.Net Wi-Fi ルータの情報を提供するクラス。
    /// @see WiFi, WiFi#saveUnitCache, WiFi#clearUnitCache
    ///
    /// このクラスのインスタンスをアプリ側で直接生成することはできない。
    /// WiFi クラスのメンバ関数 WiFi#getUnit から取得すること。
    ///
    /// このクラスが返す情報は、最新値の場合とキャッシュされた値の場合がある。
    /// キャッシュされた値であるか否かはメンバ関数 #isCache で確認できる。
    ///
    /// キャッシュに関して詳しくは WiFi クラスの説明を参照すること。
    class WiFiUnit
    {
    public:
        /// @brief コンストラクタ。
        /// @note アプリ側からは利用できない。
        explicit WiFiUnit(::amdaemon::InnerIndexHolder);

        // 下記は暗黙の定義を用いる。
        //‾WiFiUnit() = default;

        /// @brief キャッシュされた情報であるか否かを取得する。
        /// @retval true  キャッシュされた情報である場合。
        /// @retval false 最新の情報である場合。
        ///
        /// WiFi#isUnitCacheSaved と同じ値を返す。
        ///
        /// キャッシュに関して詳しくは WiFi クラスの説明を参照すること。
        bool isCache() const;

        /// @brief 情報が有効であるか否かを取得する。
        /// @retval true  有効である場合。
        /// @retval false 無効である場合。
        bool valid() const;

        /// @brief ALL.Net認証が成功済みであるか否かを取得する。
        /// @retval true  成功済みである場合。
        /// @retval false 未成功であるか、情報が無効である場合。
        /// @see #getAuthGoodText
        ///
        /// ボードではなく ALL.Net Wi-Fi ルータの認証成否であることに注意。
        ///
        /// この情報を表示に利用する場合、メンバ関数 #getAuthGoodText の利用を推奨する。
        bool isAuthGood() const;

        /// @brief ALL.Net認証が成功済みであるか否かを表す文字列を取得する。
        /// @retval "GOOD" 成功済みである場合。
        /// @retval "BAD"  未成功である場合。
        /// @retval ""     情報が無効である場合。
        /// @see #isAuthGood
        ///
        /// ゲームテストモードでの表示に用いることを想定している。
        const wchar_t* getAuthGoodText() const;

        /// @brief ルータのシリアル文字列を取得する。
        /// @return シリアル文字列。情報が無効ならば空文字列。
        const wchar_t* getSerial() const;

        /// @brief ルータのファームウェアバージョンを取得する。
        /// @return ファームウェアバージョン。情報が無効ならば空文字列。
        const wchar_t* getFirmVersion() const;

        /// @brief ALL.Net Wi-Fi サーバ群との疎通が確認できているか否かを取得する。
        /// @retval true  疎通が確認できている場合。
        /// @retval false 疎通が確認できていないか、情報が無効である場合。
        /// @see #getServerAliveText
        ///
        /// この情報を表示に利用する場合、メンバ関数 #getServerAliveText の利用を推奨する。
        bool isServerAlive() const;

        /// @brief ALL.Net Wi-Fi サーバ群との疎通が確認できているか否かを表す文字列を取得する。
        /// @retval "GOOD" 疎通が確認できている場合。
        /// @retval "BAD"  疎通が確認できていない場合。
        /// @retval ""     情報が無効である場合。
        /// @see #isServerAlive
        ///
        /// ゲームテストモードでの表示に用いることを想定している。
        const wchar_t* getServerAliveText() const;

        /// @brief ルータにアクセス中の無線子機数を取得する。
        /// @return アクセス中の無線子機数。情報が無効ならば 0 。
        std::size_t getAccessCount() const;

        /// @brief マスター ALL.Net Wi-Fi ルータのシリアル文字列を取得する。
        /// @return
        ///     シリアル文字列。マスター ALL.Net Wi-Fi ルータが見つからないならば "N/A" 。
        ///     情報が無効ならば空文字列。
        ///
        /// マスター ALL.Net Wi-Fi ルータは店舗(ロケーション)ごとに1つだけ設置される。
        /// そのためこの関数は、同じ店舗内ならばどのルータであっても同じシリアル文字列を返す。
        const wchar_t* getMasterSerial() const;

    private:
        std::size_t _unitIndex; ///< ユニットインデックス。

    private:
        // コピー禁止
        WiFiUnit(const WiFiUnit&);              // 宣言のみ
        WiFiUnit& operator=(const WiFiUnit&);   // 宣言のみ
    };

/// @}
} // namespace allnet
} // namespace amdaemon

#endif // AMDAEMON_ALLNET_WIFIUNIT_H