ErrorTimesItem.h

[詳解]

/// @file
/// @brief エラー発生回数ログ項目構造体 ErrorTimesItem のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_ERRORTIMESITEM_H
#define AMDAEMON_ERRORTIMESITEM_H

#include "amdaemon/env.h"
#include "amdaemon/ErrorDef.h"

#include <cstdint>

namespace amdaemon
{
/// @addtogroup g_error
/// @{

    /// @brief エラー発生回数ログ項目構造体。
    /// @note memcpy 可能。
    /// @internal ライブラリ実装メモ: この型を直接共有メモリに配置する。
    struct ErrorTimesItem
    {
        std::uint16_t number;   ///< エラー番号。
        std::uint32_t times;    ///< 発生回数。

        /// @brief 有効な値であるか否かを取得する。
        /// @retval true  有効な値である場合。
        /// @retval false 無効な値である場合。
        ///
        /// メンバ変数 number が 1 以上 ErrorNumberLimit 以下であれば true を返す。
        bool valid() const
        {
            return (number >= 1 && number <= ErrorNumberLimit);
        }
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_ERRORTIMESITEM_H