AM Daemon ライブラリリファレンス
公開メンバ関数 | 全メンバ一覧
amdaemon::ErrorLog クラス

エラーログ情報を提供するクラス。 [詳解]

#include <ErrorLog.h>

公開メンバ関数

 ErrorLog (InnerIndexHolder)
 コンストラクタ。 [詳解]
 
std::size_t getHistoryItemCount () const
 エラー発生履歴の有効項目数を取得する。 [詳解]
 
const ErrorInfogetHistoryItem (std::size_t index) const
 エラー発生履歴の項目を取得する。 [詳解]
 
std::size_t getTimesItemCount () const
 エラー発生回数の有効項目数を取得する。 [詳解]
 
const ErrorTimesItemgetTimesItem (std::size_t index) const
 エラー発生回数の項目を取得する。 [詳解]
 
const ErrorTimesItemfindTimesItem (std::uint32_t number) const
 エラー番号からエラー発生回数の項目を検索して取得する。 [詳解]
 

詳解

エラーログ情報を提供するクラス。

参照
Error

このクラスのインスタンスをアプリ側で直接生成することはできない。 Error クラスのメンバ関数 Error::getLog から取得すること。

構築子と解体子

amdaemon::ErrorLog::ErrorLog ( InnerIndexHolder  )
explicit

コンストラクタ。

覚え書き
アプリ側からは利用できない。

関数詳解

std::size_t amdaemon::ErrorLog::getHistoryItemCount ( ) const

エラー発生履歴の有効項目数を取得する。

戻り値
エラー発生履歴の有効項目数。最大値は amdaemon::MaxErrorHistoryItemCount
const ErrorInfo& amdaemon::ErrorLog::getHistoryItem ( std::size_t  index) const

エラー発生履歴の項目を取得する。

引数
[in]indexエラー発生履歴項目インデックス。
戻り値
エラー発生履歴項目。
例外
Exception引数 index に有効項目数以上の値を指定した場合。 有効項目数はメンバ関数 getHistoryItemCount で取得できる。

インデックスの小さい要素ほど発生日時が新しい。

std::size_t amdaemon::ErrorLog::getTimesItemCount ( ) const

エラー発生回数の有効項目数を取得する。

戻り値
エラー発生回数の有効項目数。最大値は amdaemon::MaxErrorTimesItemCount
const ErrorTimesItem& amdaemon::ErrorLog::getTimesItem ( std::size_t  index) const

エラー発生回数の項目を取得する。

引数
[in]index情報インデックス。
戻り値
エラー発生回数項目。
例外
Exception引数 index に有効項目数以上の値を指定した場合。 有効項目数はメンバ関数 getTimesItemCount で取得できる。

インデックスの小さい要素ほどエラー番号が小さい。

const ErrorTimesItem& amdaemon::ErrorLog::findTimesItem ( std::uint32_t  number) const

エラー番号からエラー発生回数の項目を検索して取得する。

引数
[in]number検索するエラー番号。 1 以上 amdaemon::ErrorNumberLimit 以下。
戻り値
エラー発生回数項目。見つからない場合は無効値。
例外
Exception引数 number に 0 もしくは amdaemon::ErrorNumberLimit より大きい値を指定した場合。

このクラス詳解は次のファイルから抽出されました: