EMoneyBrandId.h

[詳解]

/// @file
/// @brief 電子マネーブランドID列挙 EMoneyBrandId のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_EMONEYBRANDID_H
#define AMDAEMON_EMONEYBRANDID_H

#include "amdaemon/env.h"

#include <cstddef>

namespace amdaemon
{
/// @addtogroup g_emoney
/// @{

    /// 電子マネーブランドID列挙。
    enum class EMoneyBrandId
    {
        Nanaco = 0, ///< nanaco
        Edy,        ///< 楽天Edy
        Transport,  ///< 交通系(Suica, PASMO 等)
        Waon,       ///< WAON
        Paseli,     ///< PASELI
    };

    /// @brief 電子マネーブランドID定義数。
    /// @internal ライブラリ実装メモ:
    /// EMoneyBrandId::Paseli が最大値であることを前提としている。
    static const std::size_t EMoneyBrandIdCount =
        static_cast<std::size_t>(EMoneyBrandId::Paseli) + 1;

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_EMONEYBRANDID_H