Input.h

[詳解]

/// @file
/// @brief ID付けされた入力情報を提供するMonostateクラス Input のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_INPUT_H
#define AMDAEMON_INPUT_H

#include "amdaemon/env.h"
#include "amdaemon/InputUnit.h"
#include "amdaemon/util/container.h"

#include <functional>
#include <vector>
#include <cstddef>

namespace amdaemon
{
/// @addtogroup g_io
/// @{

    /// @brief ID付けされた入力情報を提供するMonostateクラス。
    ///
    /// Core クラスのメンバ関数 Core#execute 呼び出しによって内容が更新される。
    ///
    /// このクラスを利用するためには
    /// Daemonプロセスの設定ファイルに入力識別ID等の定義を行う必要がある。
    ///
    /// @ingroup g_common
    class Input
    {
    public:
        // 下記は暗黙の定義を用いる。
        //Input() = default;
        //~Input() = default;
        //Input(const Input&) = default;
        //Input& operator=(const Input&) = default;

        /// @brief システムの入力情報インスタンスを取得する。
        /// @return システムの入力情報インスタンス。
        ///
        /// TESTボタン等、プレイヤーに紐付かない入力がカテゴライズされる。
        const InputUnit& getSystem() const;

        /// @brief 有効プレイヤー数を取得する。
        /// @return 有効プレイヤー数。
        /// @see Core#getPlayerCount
        ///
        /// Core#getPlayerCount と同じ値を返す。
        std::size_t getPlayerCount() const;

        /// @brief プレイヤーの入力情報インスタンスを取得する。
        /// @param[in] playerIndex プレイヤーインデックス。
        /// @return プレイヤーの入力情報インスタンス。
        /// @see Player
        ///
        /// @exception Exception
        /// 引数 playerIndex に有効プレイヤー数以上の値を指定した場合。
        /// 有効プレイヤー数はメンバ関数 #getPlayerCount で取得できる。
        const InputUnit& getPlayer(std::size_t playerIndex) const;

        /// @brief プレイヤーの入力情報インスタンス配列を取得する。
        /// @return プレイヤーの入力情報インスタンス配列。
        ///
        /// 範囲for文や各種アルゴリズム関数に渡すことを想定している。
        ///
        /// - 有効プレイヤー数を知りたいだけならばメンバ関数 #getPlayerCount を用いること。
        /// - 特定プレイヤーの情報を取得したいだけならばメンバ関数 #getPlayer を用いること。
        std::vector<std::reference_wrapper<const InputUnit>> getPlayers() const
        {
            return
                ::amdaemon::util::toContainer<decltype(getPlayers())>(
                    getPlayerCount(),
                    [this](std::size_t i) -> const InputUnit& { return getPlayer(i); });
        }
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_INPUT_H