AimeErrorCategory.h

[詳解]

/// @file
/// @brief Aimeエラーカテゴリ列挙 AimeErrorCategory のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_AIMEERRORCATEGORY_H
#define AMDAEMON_AIMEERRORCATEGORY_H

#include "amdaemon/env.h"

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

    /// @brief Aimeエラーカテゴリ列挙。
    ///
    /// AM Daemon 用に定めたカテゴリ分けであり、Aime仕様ではない。
    enum class AimeErrorCategory
    {
        /// エラーなし。
        None = 0,

        /// @brief リトライ可能なエラー。
        ///
        /// 不正なカードをかざした場合等、リトライ可能な軽度のエラー。
        ///
        /// - Daemonプロセスが自動的にLEDをエラー点灯させるため、LED制御は不要。
        /// - Aime読み取りエラー音を鳴らすこと。
        /// - リトライで成功する可能性が高いため、再度
        ///   AimeUnit#start でポーリング処理を開始してもよい。
        ///     - リトライする場合、特にエラー情報の画面表示は行わなくとも構わない。
        ///     - LEDがエラー点灯状態から消灯状態になるまで待機してからリトライすること。
        ///       LED点灯ステータスは AimeUnit#getLedStatus で確認できる。
        Warning,

        /// @brief ネットワークエラー。
        ///
        /// DBサーバアクセス失敗等、ネットワークが関係するエラー。
        /// リトライ不可能ではないが、リトライしても同様のエラーが発生する可能性が高い。
        ///
        /// - 共通
        ///     - Aime読み取りエラー音を鳴らすこと。
        ///     - ネットワークエラーである旨を画面表示すること。
        /// - Aime必須である場合
        ///     - @ref AimeUnit#setLedStatus "AimeUnit::setLedStatus"(AimeLedStatus::Error)
        ///       でLEDをエラー点灯させること。
        /// - Aimeなしプレイに移行できる場合
        ///     - @ref AimeUnit#setLedStatus "AimeUnit::setLedStatus"(AimeLedStatus::Warning)
        ///       でLEDを警告点灯させること。
        Network,

        /// @brief 重度のエラー。
        ///
        /// ファームウェア更新失敗時およびAimeリーダー非接続時に発生する重度のエラー。
        /// 単にリトライするだけでは必ず同様のエラーが発生し続ける。
        ///
        /// - 当該Aimeリーダーが必須である場合
        ///     - Error クラスで進行停止エラーが発生するため、
        ///       進行停止エラー発生時の処理を行うこと。
        /// - 当該Aimeリーダーが必須ではない場合
        ///     - LEDは正常に点灯できない可能性が高いため制御不要。
        ///     - Aime読み取りエラー音を鳴らすこと。
        ///     - エラー情報を画面表示すること。
        Fatal,

        /// @brief アプリには返さないエラー。
        ///
        /// 内部エラーとの対応のために定義されている。
        /// AM Daemon がこのカテゴリのエラーを返すことはない。
        Unknown,
    };

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_AIMEERRORCATEGORY_H