AimeCommand.h

[詳解]

/// @file
/// @brief Aimeポーリング処理コマンド列挙 AimeCommand のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_AIMECOMMAND_H
#define AMDAEMON_AIMECOMMAND_H

#include "amdaemon/env.h"

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

    /// Aimeポーリング処理コマンド列挙。
    enum class AimeCommand
    {
        /// オフライン用ID(アクセスコードまたはFeliCaID)の読み取り処理。
        ScanOffline,

        /// UID値の読み取り処理。AimeDBやFeliCaDBへのアクセスを行う。
        /// ScanOffline の処理を含む。
        Scan,
    };

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_AIMECOMMAND_H