Jvs.h

[詳解]

/// @file
/// @brief JVSの入出力処理を提供するMonostateクラス Jvs のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_JVS_H
#define AMDAEMON_JVS_H

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

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

namespace amdaemon
{
/// @addtogroup g_jvs
/// @{

    /// @brief JVSの入出力処理を提供するMonostateクラス。
    /// @see Input, Output
    ///
    /// Core クラスのメンバ関数 Core#execute 呼び出しによって内容が更新される。
    ///
    /// JVSの生入力値を取得したり直接出力を行いたい場合に用いる。
    /// ID付けされた入出力処理を行う場合はこのクラスではなく
    /// Input クラスや Output クラスを用いること。
    ///
    /// Output クラスとは出力値を共有しており、
    /// どちらか一方で設定した出力値はもう一方にも反映される。
    ///
    /// @par プラットフォーム情報
    /// - ALLSシリーズではJVS機能は利用できない。
    /// - ALLSシリーズの場合、常にノード数(JVSボード数) 0 として扱われる。
    ///
    /// @ingroup g_common
    class Jvs
    {
    public:
        // 下記は暗黙の定義を用いる。
        //Jvs() = default;
        //‾Jvs() = default;
        //Jvs(const Jvs&) = default;
        //Jvs& operator=(const Jvs&) = default;

        /// @brief JVSの入出力機能を利用可能であるか否かを取得する。
        /// @retval true  利用可能である場合。
        /// @retval false 機能が無効である場合。
        ///
        /// 条件式 (getNodeCount() > 0) の結果を返す。
        bool isAvailable() const
        {
            return (this->getNodeCount() > 0);
        }

        /// @brief ノード数(JVSボード数)を取得する。
        /// @return ノード数(JVSボード数)。
        std::size_t getNodeCount() const;

        /// @brief ノード操作インスタンスを取得する。
        /// @param[in] nodeIndex
        ///     ノードインデックス。Node1 が 0 、Node2 が 1 のように対応する。
        /// @return ノード操作インスタンス。
        ///
        /// @exception Exception
        /// 引数 nodeIndex にノード数以上の値を指定した場合。
        /// ノード数はメンバ関数 #getNodeCount で取得できる。
        JvsNode& getNode(std::size_t nodeIndex);

        /// @copydoc getNode
        const JvsNode& getNode(std::size_t nodeIndex) const;

        /// @brief ノード操作インスタンス配列を取得する。
        /// @return ノード操作インスタンス配列。
        ///
        /// 範囲for文や各種アルゴリズム関数に渡すことを想定している。
        ///
        /// - ノード数を知りたいだけならばメンバ関数 #getNodeCount を用いること。
        /// - 特定ノードを取得したいだけならばメンバ関数 #getNode を用いること。
        std::vector<std::reference_wrapper<JvsNode>> getNodes()
        {
            return
                ::amdaemon::util::toContainer<decltype(getNodes())>(
                    getNodeCount(),
                    [this](std::size_t i) -> JvsNode& { return getNode(i); });
        }

        /// @copydoc getNodes
        std::vector<std::reference_wrapper<const JvsNode>> getNodes() const
        {
            return
                ::amdaemon::util::toContainer<decltype(getNodes())>(
                    getNodeCount(),
                    [this](std::size_t i) -> const JvsNode& { return getNode(i); });
        }
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_JVS_H