SequenceBookkeeping.h

[詳解]

/// @file
/// @brief プレイ回数やプレイ時間関連のブックキーピング構造体 SequenceBookkeeping のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_SEQUENCEBOOKKEEPING_H
#define AMDAEMON_SEQUENCEBOOKKEEPING_H

#include "amdaemon/env.h"

#include <cstdint>
#include <cstddef>

namespace amdaemon
{
/// @addtogroup g_sequence
/// @{

    /// @brief TIME HISTOGRAM の範囲単体を保持する構造体。
    /// @note memcpy 可能。
    /// @internal ライブラリ実装メモ: この型を直接共有メモリに配置する。
    struct TimeHistogramItem
    {
        std::uint32_t timeRangeMin; ///< プレイ秒数範囲の最小値。

        /// プレイ秒数範囲の最大値。
        /// 上限なしを表す場合は UINT32_MAX が設定される。
        std::uint32_t timeRangeMax;

        std::uint32_t count;        ///< カウント数。

        /// @brief プレイ秒数範囲が上限なしであるか否かを取得する。
        /// @retval true  上限なしである場合。
        /// @retval false 上限がある場合。
        bool isTimeRangeUnlimited() const
        {
            return (this->timeRangeMax == UINT32_MAX);
        }
    };

    /// @brief プレイ回数やプレイ時間関連のブックキーピング構造体。
    /// @see CreditBookkeeping
    /// @note memcpy 可能。
    ///
    /// 各設定値の詳細はビデオゲーム作成基準を参照すること。
    ///
    /// TIME HISTOGRAM の有効数や各時間範囲は設定ファイルで指定したものとなる。
    ///
    /// @internal ライブラリ実装メモ: この型を直接共有メモリに配置する。
    struct SequenceBookkeeping
    {
        /// プレイ時間分布の最大スロット数。
        static const std::size_t MaxTimeHistogramCount = 32;

        std::uint32_t numberOfGames;                            ///< NUMBER OF GAMES の値。
        std::uint32_t totalTime;                                ///< TOTAL TIME の秒数値。
        std::uint32_t playTime;                                 ///< PLAY TIME の秒数値。
        std::uint32_t averagePlayTime;                          ///< AVERAGE PLAY TIME の秒数値。
        std::uint32_t longestPlayTime;                          ///< LONGEST PLAY TIME の秒数値。
        std::uint32_t shortestPlayTime;                         ///< SHORTEST PLAY TIME の秒数値。
        std::uint32_t timeHistogramCount;                       ///< TIME HISTOGRAM の有効数。
        TimeHistogramItem timeHistogram[MaxTimeHistogramCount]; ///< TIME HISTOGRAM の値配列。
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_SEQUENCEBOOKKEEPING_H