AccountingPlayCountItem.h

[詳解]

/// @file
/// @brief ALL.Net課金プレイ回数集計アイテム構造体 AccountingPlayCountItem のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_ALLNET_ACCOUNTINGPLAYCOUNTITEM_H
#define AMDAEMON_ALLNET_ACCOUNTINGPLAYCOUNTITEM_H

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

#include <string>
#include <cstdint>
#include <cstddef>

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

    /// @brief ALL.Net課金プレイ回数集計アイテム構造体。
    /// @note memcpy 可能。
    /// @internal ライブラリ実装メモ: この型を直接共有メモリに配置する。
    struct AccountingPlayCountItem
    {
        /// @brief 対象年月。年と月以外の値は無意味。
        ///
        /// 情報が無効ならば amdaemon::util::DateTime::min() が設定される。
        /// 情報が有効であるか否かはメンバ関数 #valid で調べること。
        ::amdaemon::util::DateTime month;

        /// 課金プレイ回数。
        std::uint32_t count;

        /// @brief 情報が有効であるか否かを取得する。
        /// @retval true  有効である場合。
        /// @retval false 無効である場合。
        bool valid() const
        {
            return (month != ::amdaemon::util::DateTime::min());
        }

        /// @brief 文字列表現値を作成する。
        /// @param[in] countWidth 課金プレイ回数の最小幅。既定値は 5 。
        /// @return 文字列表現値。情報が無効である場合は空文字列。
        ///
        /// "YYYY/MM XXXXX" という形式の文字列を返す。
        ///
        /// - "YYYY" は年を表す。
        /// - "MM" は2桁幅となるようにゼロ埋めされた月を表す。
        /// - "XXXXX" は引数 countWidth で指定した最小幅を満たすように空白文字で
        ///   右寄せされた課金プレイ回数値を表す。
        std::wstring toString(std::size_t countWidth = 5) const;
    };

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

#endif // AMDAEMON_ALLNET_ACCOUNTINGPLAYCOUNTITEM_H