ErrorInfo.h

[詳解]

/// @file
/// @brief エラー情報を保持する抽象クラス ErrorInfo のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_ERRORINFO_H
#define AMDAEMON_ERRORINFO_H

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

#include <string>
#include <cstdint>

namespace amdaemon
{
    /// @brief エラー情報を保持する抽象クラス。
    ///
    /// このクラスのインスタンスをアプリ側で直接生成することはできない。
    /// Error クラスや Network クラスのメンバ関数から取得すること。
    ///
    /// @ingroup g_error, g_network
    class ErrorInfo
    {
    public:
        /// コンストラクタ。
        ErrorInfo() { }

        /// デストラクタ。
        virtual ‾ErrorInfo() { }

        /// @brief エラーが発生しているか否かを取得する。
        /// @retval true  エラーが発生している場合。
        /// @retval false エラーが発生していない場合。
        ///
        /// 既定では、条件式 (getNumber() != 0) の結果を返す。
        virtual bool isOccurred() const
        {
            return (getNumber() != 0);
        }

        /// @brief エラー番号を取得する。
        /// @return エラー番号。エラーが発生していなければ 0 。
        virtual std::uint32_t getNumber() const = 0;

        /// @brief サブエラー番号(枝番)を取得する。
        /// @return サブエラー番号(枝番)。枝番が無いならば 0 。
        virtual std::uint32_t getSubNumber() const = 0;

        /// @brief エラーメッセージを取得する。
        /// @return エラーメッセージ。エラーが発生していなければ不定値。
        virtual const wchar_t* getMessage() const = 0;

        /// @brief エラーリセット種別を取得する。
        /// @return エラーリセット種別。エラーが発生していなければ不定値。
        virtual ErrorResetType getResetType() const = 0;

        /// @brief エラー発生日時を取得する。
        /// @return エラー発生日時。エラーが発生していなければ不定値。
        virtual const ::amdaemon::util::DateTime& getTime() const = 0;

        /// @brief エラーの文字列表現値を作成する。
        /// @return エラーの文字列表現値。エラーが発生していなければ空文字列。
        /// @note デバッグ用。
        ///
        /// 例えば下記のような文字列を機械的に作成して返す。
        ///
        /// - "ERROR 1001 : Invalid operation. [2015/07/01 09:00:00]"
        /// - "ERROR 1002-01 : 不正な処理です。 [2015/07/01 10:00:00]"
        ///
        /// ただしエラーが発生していない場合は空文字列を返す。
        std::wstring toString() const;

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

#endif // AMDAEMON_ERRORINFO_H