JvsNode.h

[詳解]

/// @file
/// @brief JVSボード単体の入出力処理を提供するクラス JvsNode のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_JVSNODE_H
#define AMDAEMON_JVSNODE_H

#include "amdaemon/env.h"
#include "amdaemon/JvsSwitchInput.h"
#include "amdaemon/JvsAnalogInput.h"
#include "amdaemon/JvsRotaryInput.h"
#include "amdaemon/JvsGeneralOutput.h"

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

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

    /// @brief JVSボード単体の入出力処理を提供するクラス。
    /// @see Jvs
    ///
    /// このクラスのインスタンスをアプリ側で直接生成することはできない。
    /// Jvs クラスのメンバ関数 Jvs#getNode から取得すること。
    class JvsNode
    {
    public:
        /// @brief コンストラクタ。
        /// @note アプリ側からは利用できない。
        explicit JvsNode(InnerIndexHolder);

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

        /// @brief スイッチ入力情報インスタンスを取得する。
        /// @return スイッチ入力情報インスタンス。
        const JvsSwitchInput& getSwitchInput() const
        {
            return _switchInput;
        }

        /// @brief アナログ入力情報インスタンスを取得する。
        /// @return アナログ入力情報インスタンス。
        const JvsAnalogInput& getAnalogInput() const
        {
            return _analogInput;
        }

        /// @brief ロータリ入力情報インスタンスを取得する。
        /// @return ロータリ入力情報インスタンス。
        const JvsRotaryInput& getRotaryInput() const
        {
            return _rotaryInput;
        }

        /// @brief 汎用ドライバ出力処理インスタンスを取得する。
        /// @return 汎用ドライバ出力処理インスタンス。
        JvsGeneralOutput& getGeneralOutput()
        {
            return _generalOutput;
        }

        /// @copydoc getGeneralOutput
        const JvsGeneralOutput& getGeneralOutput() const
        {
            return _generalOutput;
        }

    private:
        JvsSwitchInput _switchInput;        ///< スイッチ入力。
        JvsAnalogInput _analogInput;        ///< アナログ入力。
        JvsRotaryInput _rotaryInput;        ///< ロータリ入力。
        JvsGeneralOutput _generalOutput;    ///< 汎用デバイス出力。

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_JVSNODE_H