AimeLedStatus.h

[詳解]

/// @file
/// @brief AimeのLED点灯ステータス列挙 AimeLedStatus のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_AIMELEDSTATUS_H
#define AMDAEMON_AIMELEDSTATUS_H

#include "amdaemon/env.h"

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

    /// @brief AimeのLED点灯ステータス列挙。
    ///
    /// AimeUnit クラスの説明およびAime作成基準を参照すること。
    enum class AimeLedStatus
    {
        None = 0,   ///< ステータスなし。明示的に指定した場合は消灯する。
        Scanning,   ///< 読み取り処理中の白点灯。別のLED制御が行われるまで点灯し続ける。
        Success,    ///< 読み取り成功時の青点灯。一定時間点灯後に消灯する。
        Warning,    ///< オフライン動作時等の黄点灯。一定時間点灯後に消灯する。
        Error,      ///< 読み取り失敗時の赤点灯。一定時間点灯後に消灯する。
    };

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_AIMELEDSTATUS_H