AimeErrorId.h

[詳解]

/// @file
/// @brief Aime内部エラーID列挙 AimeErrorId のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_AIMEERRORID_H
#define AMDAEMON_AIMEERRORID_H

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

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

    /// @brief Aime内部エラーID列挙。
    ///
    /// AiMeLibの AiMeDef::eAiMeError 列挙に対応している。
    /// AM Daemon では返すことのないエラーも含まれる。
    enum class AimeErrorId
    {
        None = 0,               ///< エラーなし。

        ReaderSetupFail,        ///< リーダー初期化失敗。
        ReaderFirmFileInvalid,  ///< リーダーファームウェアファイル不正。
        ReaderFirmUpToDate,     ///< リーダーファームウェア更新済み。
        ReaderAccessFail,       ///< リーダーアクセス失敗。
        ReaderTimeout,          ///< リーダーカード検出タイムアウト。
        ReaderIncompatible,     ///< 互換性のないカードを検出。
        ReaderTwoOrMore,        ///< 2枚以上のカードを検出。
        DBResolveFail,          ///< DBサーバ名前解決失敗。
        DBAccessTimeout,        ///< DBサーバアクセスタイムアウト。
        DBAccessFail,           ///< DBサーバアクセスエラー。
        FeliCaInvalid,          ///< 無効なFeliCaを検出。
        FeliCaNotFound,         ///< FeliCa未登録。
        FeliCaRegisterFail,     ///< FeliCa登録失敗。
        AimeIdInvalid,          ///< 無効なUIDを検出。
        AimeIdNotFound,         ///< UID未登録。
        AimeIdRegisterFail,     ///< UID登録失敗。
        FeliCaRequired,         ///< FeliCa非検出。
        CardRequired,           ///< Aimeカード非検出。
        NoBoardInfo,            ///< 基板情報未設定。
        LogRegisterFail,        ///< ログ登録失敗。
        FeliCaRegistered,       ///< FeliCa登録済み。
        AimeIdRegistered,       ///< UID登録済み。

        LockBanSystemUser,      ///< BANシステムユーザーロック状態。
        LockBanSystem,          ///< BANシステムロック状態。
        LockBanUser,            ///< BANユーザーロック状態。
        LockBan,                ///< BANロック状態。
        LockSystemUser,         ///< システムユーザーロック状態。
        LockSystem,             ///< システムロック状態。
        LockUser,               ///< ユーザーロック状態。

        ReaderFirmUpdateFail,   ///< リーダーファームウェア更新失敗。
        CampaignInfoFail,       ///< キャンペーン情報取得失敗。
        ReaderDetectFail,       ///< リーダーカード検出失敗。
        FeliCaComFail,          ///< FeliCa通信失敗。
    };

    /// @brief @ref AimeErrorId 列挙値の文字列表現値を取得する。
    /// @param[in] id @ref AimeErrorId 列挙値。
    /// @return @ref AimeErrorId 列挙値の文字列表現値。不正値の場合は nullptr 。
    /// @internal ライブラリ実装メモ: enumsToString.cpp で実装。
    const wchar_t* toString(AimeErrorId id);

    /// @brief @ref AimeErrorId 列挙値に対応する @ref AimeErrorCategory 列挙値を取得する。
    /// @param[in] id @ref AimeErrorId 列挙値。
    /// @return @ref AimeErrorCategory 列挙値。
    ///
    /// @exception Exception
    /// 引数 id に不正な値を指定した場合。
    AimeErrorCategory getCategory(AimeErrorId id);

/// @}
} // namespace amdaemon

#endif // AMDAEMON_AIMEERRORID_H