AimeErrorInfo.h

[詳解]

/// @file
/// @brief Aime関連エラー情報を提供するクラス AimeErrorInfo のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_AIMEERRORINFO_H
#define AMDAEMON_AIMEERRORINFO_H

#include "amdaemon/env.h"
#include "amdaemon/AimeErrorId.h"
#include "amdaemon/AimeErrorCategory.h"
#include "amdaemon/ErrorInfo.h"

#include <cstddef>

namespace amdaemon
{
/// @addtogroup g_aime
/// @{

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

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

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

        /// @brief 内部エラーID値を取得する。
        /// @return 内部エラーID値。エラーが発生していなければ AimeErrorId::None 。
        AimeErrorId getId() const;

        /// @brief エラーカテゴリ値を取得する。
        /// @return エラーカテゴリ値。エラーが発生していなければ AimeErrorCategory::None 。
        ///
        /// Aime読み取りエラー発生時の処理をこの値で切り分けることができる。
        /// 詳細は各 @ref AimeErrorCategory 列挙値の説明を参照すること。
        AimeErrorCategory getCategory() const;

        /// @brief エラーが発生しているか否かを取得する。
        /// @retval true  エラーが発生している場合。
        /// @retval false エラーが発生していない場合。
        ///
        /// 条件式 (getId() != AimeErrorId::None) の結果を返す。
        bool isOccurred() const override
        {
            return (getId() != AimeErrorId::None);
        }

        /// @brief エラー番号を取得する。
        /// @return
        ///     エラー番号。エラーが発生していないか、エラー番号が定義されていなければ 0 。
        ///
        /// エラーが発生していても、エラー番号が定義されていない場合は 0 を返す。
        /// エラーが発生しているか否かはメンバ関数 #isOccurred で判別すること。
        ///
        /// エラーメッセージ表示時にはこのエラー番号を同時に表示することが好ましい。
        std::uint32_t getNumber() const override;

        /// @brief サブエラー番号(枝番)を取得する。
        /// @return サブエラー番号(枝番)。枝番が無いならば 0 。
        ///
        /// - エラーが発生しており、Aimeリーダーが 2 台以上接続されている場合は
        ///   (ユニットインデックス + 1) を返す。
        /// - エラーが発生していないか、Aimeリーダーが 1 台のみの場合は常に 0 を返す。
        std::uint32_t getSubNumber() const override;

        /// @brief エラーメッセージを取得する。
        /// @return エラーメッセージ。エラーが発生していなければ不定値。
        ///
        /// エラーが発生していても、エラーメッセージが定義されていない場合は空文字列を返す。
        /// エラーが発生しているか否かはメンバ関数 #isOccurred で判別すること。
        const wchar_t* getMessage() const override;

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

    private:
        /// @brief エラーリセット種別を取得する。
        /// @return 常に ErrorResetType::None 。
        ErrorResetType getResetType() const override;

    private:
        std::size_t _unitIndex; ///< ユニットインデックス。

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_AIMEERRORINFO_H