UsbIOUniqueInput.h

[詳解]

/// @file
/// @brief USB I/O のユニーク入力情報を提供するクラス UsbIOUniqueInput のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_USBIOUNIQUEINPUT_H
#define AMDAEMON_USBIOUNIQUEINPUT_H

#include "amdaemon/env.h"

#include <cstdint>
#include <cstddef>

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

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

    /// @brief USB I/O のユニーク入力情報を提供するクラス。
    /// @see UsbIO, UsbIONode
    ///
    /// このクラスのインスタンスをアプリ側で直接生成することはできない。
    /// UsbIONode クラスのメンバ関数 UsbIONode#getAnalogInput から取得すること。
    ///
    /// ユニークコマンドによる USB I/O のインタラプト入力情報を提供する。
    /// Daemonプロセスの設定ファイルで指定した命令コードのみがサポートされる。
    class UsbIOUniqueInput
    {
    public:
        /// RESERVE 領域サイズ。
        static const std::size_t RawDataSize = 29;

    public:
        /// @brief コンストラクタ。
        /// @note アプリ側からは利用できない。
        explicit UsbIOUniqueInput(InnerIndexHolder);

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

        /// @brief 指定した命令コードがサポートされているか否かを取得する。
        /// @param[in] command 命令コード。
        /// @retval true  サポートされている場合。
        /// @retval false サポートされていない場合。
        ///
        /// Daemonプロセスの設定ファイルで指定した命令コードであれば true を返す。
        bool isSupported(std::uint8_t command) const;

        /// @brief ユニークコマンドによる入力データを取得する。
        /// @param[in] command 命令コード。
        /// @param[out] dataSize 入力データサイズの設定先。不要ならば nullptr 。
        /// @return 入力データ。データが存在しない場合は nullptr 。
        ///
        /// @exception Exception
        /// 引数 command にサポートされていない命令コードを指定した場合。
        ///
        /// USB I/O 入力情報の RESERVE 領域値を解析し、命令コードに対応する入力データを返す。
        ///
        /// サポートされているが入力データの存在しない命令コードを指定した場合は
        /// nullptr を返し、引数 dataSize には 0 が設定される。
        ///
        /// サポートされていない命令コードを指定した場合は、
        /// 実際の入力データが存在するか否かに関わらず例外が送出される。
        const void* get(std::uint8_t command, std::size_t* dataSize = nullptr) const;

        /// @brief 生の RESERVE 領域値を取得する。
        /// @return 生の RESERVE 領域値。データサイズは #RawDataSize 。
        ///
        /// USB I/O 入力情報の RESERVE 領域値を加工せずそのまま返す。
        /// ユニークコマンドによる入力機能を提供する基板は、この領域に入力情報を返す。
        ///
        /// 通常は、この関数ではなくメンバ関数 #get を用いること。
        const void* getRaw() const;

    private:
        std::size_t _nodeIndex; ///< ノードインデックス。

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

/// @}
} // namespace amdaemon

#endif // AMDAEMON_USBIOUNIQUEINPUT_H