EMoneyBrand.h

[詳解]

/// @file
/// @brief 電子マネーのブランド情報を提供するクラス EMoneyBrand のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_EMONEYBRAND_H
#define AMDAEMON_EMONEYBRAND_H

#include "amdaemon/env.h"
#include "amdaemon/EMoneyBrandId.h"
#include "amdaemon/EMoneyDef.h"

#include <memory>

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

    // 内部クラスの前方宣言
    class InnerIndexHolder;

    /// @brief 電子マネーのブランド情報を提供するクラス。
    /// @see EMoney
    ///
    /// このクラスのインスタンスをアプリ側で直接生成することはできない。
    /// EMoney クラスのメンバ関数 EMoney#getAvailableBrand 等から取得すること。
    ///
    /// @par アイコン画像表示について
    /// 一般業務用の電子マネー対応アプリでは、メンバ関数 #getIconFilePath が返す
    /// アイコン画像PNGファイルの絶対パスを用いて画面上にアイコン画像表示を行うが、
    /// この方法はゲーム用途にはそぐわない場合が多い。
    /// @par
    /// そこで、メンバ関数 #getId などの情報を用いて、
    /// ゲームアプリにとって最適な手段でアイコン画像表示を行っても構わない。
    /// 当然ながら、表示される画像は本来のPNG画像と同等のものにすること。
    class EMoneyBrand
    {
    public:
        /// @brief コンストラクタ。
        /// @note アプリ側からは利用できない。
        EMoneyBrand(InnerIndexHolder, InnerIndexHolder);

        // 下記は暗黙の定義を用いる。
        //‾EMoneyBrand();

        /// @brief ブランドIDを取得する。
        /// @return ブランドID。
        EMoneyBrandId getId() const;

        /// @brief ブランド名を取得する。
        /// @return ブランド名。
        ///
        /// 最大文字数は amdaemon::MaxEMoneyBrandNameLength 。終端文字を含まない。
        const wchar_t* getName() const;

        /// @brief ブランドに対応するアイコン画像PNGファイルパスを取得する。
        /// @return アイコン画像PNGファイルパス。
        ///
        /// 設定ファイルで指定したリソースディレクトリ以下にある、
        /// アイコン画像PNGファイルのパスを返す。
        ///
        /// アイコン画像表示については EMoneyBrand クラスの説明を参照すること。
        ///
        /// ファイル名のみ利用したい場合、 util::Path クラスの静的メンバ関数
        /// util::Path::getName を用いるとよい。
        const wchar_t* getIconFilePath() const;

    private:
        std::size_t _ref;   ///< 内部参照種別値。
        std::size_t _index; ///< 内部インデックス。

    private:
        // コピー禁止
        EMoneyBrand(const EMoneyBrand&);            // 宣言のみ
        EMoneyBrand& operator=(const EMoneyBrand&); // 宣言のみ
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_EMONEYBRAND_H