NetDeliveryOptionImageInfo.h

[詳解]

/// @file
/// @brief NET配信オプションイメージ情報構造体 NetDeliveryOptionImageInfo のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_NETDELIVERYOPTIONIMAGEINFO_H
#define AMDAEMON_NETDELIVERYOPTIONIMAGEINFO_H

#include "amdaemon/env.h"
#include "amdaemon/NetDeliveryStatus.h"
#include "amdaemon/NetDeliveryProgress.h"

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

    /// @brief NET配信オプションイメージ情報構造体。
    /// @note memcpy 可能。
    ///
    /// - メンバ変数 progress は、
    ///   配信指示書の COMMON セクションに指定したイメージの配信進捗合算値を表す。
    /// - メンバ変数 optionalProgress は、
    ///   配信指示書の OPTIONAL セクションに指定したイメージの配信進捗合算値を表す。
    ///
    /// @internal ライブラリ実装メモ: この型を直接共有メモリに配置する。
    struct NetDeliveryOptionImageInfo
    {
        NetDeliveryStatus status;               ///< 配信ステータス。
        NetDeliveryProgress progress;           ///< 配信対象イメージ配信進捗。
        NetDeliveryProgress optionalProgress;   ///< オプショナルイメージ配信進捗。

        /// @brief 配信対象イメージとオプショナルイメージの配信進捗合算値を算出する。
        /// @return 配信対象イメージとオプショナルイメージの配信進捗合算値。
        NetDeliveryProgress calcTotalProgress() const
        {
            NetDeliveryProgress result = { };
            result.total = this->progress.total + this->optionalProgress.total;
            result.current = this->progress.current + this->optionalProgress.current;
            return result;
        }
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_NETDELIVERYOPTIONIMAGEINFO_H