NetDelivery.h

[詳解]

/// @file
/// @brief NET配信情報を提供するMonostateクラス NetDelivery のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_NETDELIVERY_H
#define AMDAEMON_NETDELIVERY_H

#include "amdaemon/env.h"
#include "amdaemon/NetDeliveryTimeInfo.h"
#include "amdaemon/NetDeliveryAppImageInfo.h"
#include "amdaemon/NetDeliveryOptionImageInfo.h"

namespace amdaemon
{
/// @addtogroup g_netdelivery
/// @{

    /// @brief NET配信情報を提供するMonostateクラス。
    ///
    /// Core クラスのメンバ関数 Core#execute 呼び出しによって内容が更新される。
    ///
    /// @par ゲームテストモードでの配信状況表示
    /// NET配信機能に対応する場合、ゲームテストモードにてアプリイメージおよび
    /// オプションイメージの配信状況表示メニューを実装すること。
    /// @par
    /// - アプリイメージの配信状況
    ///     - 現在動作中のアプリバージョンは AppImage クラスのメンバ関数
    ///       AppImage#getCurrentVersion で取得できる。
    ///     - 配信中のアプリバージョンは getAppImageInfo().version で取得できる。
    ///     - 配信進捗は getAppImageInfo().progress で取得できる。
    ///     - 配信開始日時は getAppTimeInfo().order で取得できる。
    ///     - 公開日時は getAppTimeInfo().release で取得できる。
    ///     - 配信ステータスは getAppImageInfo().status で取得できる。
    ///       関数 amdaemon::toString(NetDeliveryStatus, bool) で文字列表現値を取得できる。
    ///     - メンバ関数 #existsApp が false を返す場合、下記項目はハイフン表示とすること。
    ///         - 配信中のアプリバージョン
    ///         - 配信進捗
    ///         - 配信開始日時
    ///         - 公開日時
    /// - オプションイメージの配信状況
    ///     - 配信進捗は getOptionImageInfo().calcTotalProgress() で取得できる。
    ///     - 配信開始日時は getOptionTimeInfo().order で取得できる。
    ///     - 公開日時は getOptionTimeInfo().release で取得できる。
    ///     - 配信ステータスは getOptionImageInfo().status で取得できる。
    ///       関数 amdaemon::toString(NetDeliveryStatus, bool) で文字列表現値を取得できる。
    ///     - メンバ関数 #existsOption が false を返す場合、下記項目はハイフン表示とすること。
    ///         - 配信進捗
    ///         - 配信開始日時
    ///         - 公開日時
    ///
    /// @ingroup g_common
    class NetDelivery
    {
    public:
        // 下記は暗黙の定義を用いる。
        //NetDelivery() = default;
        //‾NetDelivery() = default;
        //NetDelivery(const NetDelivery&) = default;
        //NetDelivery& operator=(const NetDelivery&) = default;

        /// @brief NET配信クライアントとして動作するか否かを取得する。
        /// @retval true  NET配信クライアントとして動作する場合。
        /// @retval false NET配信クライアントとして動作しない場合。
        ///
        /// Daemonプロセスの設定ファイルでNET配信設定を有効にしている場合であっても、
        /// キーチップのALL.Net認証フラグが無効である場合は false を返す。
        bool isAvailable() const;

        /// @brief NET配信によるセガブート遷移要求があるか否かを取得する。
        /// @retval true  セガブート遷移要求がある場合。
        /// @retval false セガブート遷移要求がない場合。
        /// @see Core#kill
        ///
        /// NET配信クライアントとして動作していない場合は常に false を返す。
        ///
        /// NET配信クライアントとして動作しており、この関数が true を返す場合、
        /// イメージ更新のためにアプリ終了フローへ遷移する必要がある。
        /// アプリ終了フローについては Core クラスの説明を参照すること。
        bool isExitNeeded() const;

    public:
        // アプリイメージ情報

        /// @brief 配信処理対象アプリイメージが存在するか否かを取得する。
        /// @retval true  存在する場合。
        /// @retval false 存在しない場合。
        ///
        /// getAppTimeInfo().existsImage() を返す。
        bool existsApp() const
        {
            return this->getAppTimeInfo().existsImage();
        }

        /// @brief 配信処理対象アプリイメージの日時情報を取得する。
        /// @return 配信処理対象アプリイメージの日時情報。
        const NetDeliveryTimeInfo& getAppTimeInfo() const;

        /// @brief 配信処理対象アプリイメージのイメージ情報を取得する。
        /// @return イメージ情報。
        ///
        /// 対象イメージが複数指定されている場合、それらを合算した情報を返す。
        const NetDeliveryAppImageInfo& getAppImageInfo() const;

    public:
        // オプションイメージ情報

        /// @brief 配信処理対象オプションイメージが存在するか否かを取得する。
        /// @retval true  存在する場合。
        /// @retval false 存在しない場合。
        ///
        /// getOptionTimeInfo().existsImage() を返す。
        bool existsOption() const
        {
            return this->getOptionTimeInfo().existsImage();
        }

        /// @brief 配信処理対象オプションイメージの日時情報を取得する。
        /// @return 配信処理対象オプションイメージの日時情報。
        const NetDeliveryTimeInfo& getOptionTimeInfo() const;

        /// @brief 配信処理対象オプションイメージのイメージ情報を取得する。
        /// @return イメージ情報。
        ///
        /// 対象イメージが複数指定されている場合、それらを合算した情報を返す。
        const NetDeliveryOptionImageInfo& getOptionImageInfo() const;
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_NETDELIVERY_H