ErrorLog.h

[詳解]

/// @file
/// @brief エラーログ情報を提供するクラス ErrorLog のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_ERRORLOG_H
#define AMDAEMON_ERRORLOG_H

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

#include <cstdint>
#include <cstddef>

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

    // 内部クラスの前方宣言
    class InnerIndexHolder;

    /// @brief エラーログ情報を提供するクラス。
    /// @see Error
    ///
    /// このクラスのインスタンスをアプリ側で直接生成することはできない。
    /// Error クラスのメンバ関数 Error#getLog から取得すること。
    class ErrorLog
    {
    public:
        /// @brief コンストラクタ。
        /// @note アプリ側からは利用できない。
        explicit ErrorLog(InnerIndexHolder);

        // 下記は暗黙の定義を用いる。
        //‾ErrorLog() = default;

        /// @brief エラー発生履歴の有効項目数を取得する。
        /// @return エラー発生履歴の有効項目数。最大値は amdaemon::MaxErrorHistoryItemCount 。
        std::size_t getHistoryItemCount() const;

        /// @brief エラー発生履歴の項目を取得する。
        /// @param[in] index エラー発生履歴項目インデックス。
        /// @return エラー発生履歴項目。
        ///
        /// @exception Exception
        /// 引数 index に有効項目数以上の値を指定した場合。
        /// 有効項目数はメンバ関数 #getHistoryItemCount で取得できる。
        ///
        /// インデックスの小さい要素ほど発生日時が新しい。
        const ErrorInfo& getHistoryItem(std::size_t index) const;

        /// @brief エラー発生回数の有効項目数を取得する。
        /// @return エラー発生回数の有効項目数。最大値は amdaemon::MaxErrorTimesItemCount 。
        std::size_t getTimesItemCount() const;

        /// @brief エラー発生回数の項目を取得する。
        /// @param[in] index 情報インデックス。
        /// @return エラー発生回数項目。
        ///
        /// @exception Exception
        /// 引数 index に有効項目数以上の値を指定した場合。
        /// 有効項目数はメンバ関数 #getTimesItemCount で取得できる。
        ///
        /// インデックスの小さい要素ほどエラー番号が小さい。
        const ErrorTimesItem& getTimesItem(std::size_t index) const;

        /// @brief エラー番号からエラー発生回数の項目を検索して取得する。
        /// @param[in] number 検索するエラー番号。 1 以上 amdaemon::ErrorNumberLimit 以下。
        /// @return エラー発生回数項目。見つからない場合は無効値。
        ///
        /// @exception Exception
        /// 引数 number に 0 もしくは amdaemon::ErrorNumberLimit より大きい値を指定した場合。
        const ErrorTimesItem& findTimesItem(std::uint32_t number) const;

    private:
        // コピー禁止
        ErrorLog(const ErrorLog&);              // 宣言のみ
        ErrorLog& operator=(const ErrorLog&);   // 宣言のみ
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_ERRORLOG_H