UsbIONode.h

[詳解]

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

#ifndef AMDAEMON_USBIONODE_H
#define AMDAEMON_USBIONODE_H

#include "amdaemon/env.h"
#include "amdaemon/UsbIOSwitchInput.h"
#include "amdaemon/UsbIOAnalogInput.h"
#include "amdaemon/UsbIORotaryInput.h"
#include "amdaemon/UsbIOUniqueInput.h"
#include "amdaemon/UsbIOGeneralOutput.h"
#include "amdaemon/UsbIOPwmOutput.h"
#include "amdaemon/UsbIOUniqueOutput.h"
#include "amdaemon/RequestState.h"

namespace amdaemon
{
/// @addtogroup g_usbio
/// @{

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

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

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

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

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

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

        /// @brief ユニーク入力情報インスタンスを取得する。
        /// @return ユニーク入力情報インスタンス。
        const UsbIOUniqueInput& getUniqueInput() const
        {
            return _uniqueInput;
        }

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

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

        /// @brief PWM出力処理インスタンスを取得する。
        /// @return PWM出力処理インスタンス。
        UsbIOPwmOutput& getPwmOutput()
        {
            return _pwmOutput;
        }

        /// @copydoc getPwmOutput
        const UsbIOPwmOutput& getPwmOutput() const
        {
            return _pwmOutput;
        }

        /// @brief ユニーク出力処理インスタンスを取得する。
        /// @return ユニーク出力処理インスタンス。
        UsbIOUniqueOutput& getUniqueOutput()
        {
            return _uniqueOutput;
        }

        /// @copydoc getUniqueOutput
        const UsbIOUniqueOutput& getUniqueOutput() const
        {
            return _uniqueOutput;
        }

    private:
        UsbIOSwitchInput _switchInput;      ///< スイッチ入力。
        UsbIOAnalogInput _analogInput;      ///< アナログ入力。
        UsbIORotaryInput _rotaryInput;      ///< ロータリ入力。
        UsbIOUniqueInput _uniqueInput;      ///< ユニーク入力。
        UsbIOGeneralOutput _generalOutput;  ///< 汎用出力。
        UsbIOPwmOutput _pwmOutput;          ///< PWM出力。
        UsbIOUniqueOutput _uniqueOutput;    ///< ユニーク出力。

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_USBIONODE_H