USB I/O のユニーク入力情報を提供するクラス。 [詳解]

公開メンバ関数
	UsbIOUniqueInput (InnerIndexHolder)
	コンストラクタ。 [詳解]

bool	isSupported (std::uint8_t command) const
	指定した命令コードがサポートされているか否かを取得する。 [詳解]

const void *	get (std::uint8_t command, std::size_t *dataSize=nullptr) const
	ユニークコマンドによる入力データを取得する。 [詳解]

const void *	getRaw () const
	生の RESERVE 領域値を取得する。 [詳解]

詳解

USB I/O のユニーク入力情報を提供するクラス。

このクラスのインスタンスをアプリ側で直接生成することはできない。 UsbIONode クラスのメンバ関数 UsbIONode::getAnalogInput から取得すること。

ユニークコマンドによる USB I/O のインタラプト入力情報を提供する。 Daemonプロセスの設定ファイルで指定した命令コードのみがサポートされる。

構築子と解体子

amdaemon::UsbIOUniqueInput::UsbIOUniqueInput ( InnerIndexHolder )

explicit

コンストラクタ。

bool amdaemon::UsbIOUniqueInput::isSupported ( std::uint8_t command ) const

指定した命令コードがサポートされているか否かを取得する。

引数

[in] command 命令コード。

戻り値

true	サポートされている場合。
false	サポートされていない場合。

Daemonプロセスの設定ファイルで指定した命令コードであれば true を返す。

const void* amdaemon::UsbIOUniqueInput::get	(	std::uint8_t	command,
		std::size_t *	dataSize = `nullptr`
	)		const

ユニークコマンドによる入力データを取得する。

引数

[in]	command	命令コード。
[out]	dataSize	入力データサイズの設定先。不要ならば nullptr 。

例外

Exception 引数 command にサポートされていない命令コードを指定した場合。

USB I/O 入力情報の RESERVE 領域値を解析し、命令コードに対応する入力データを返す。

サポートされているが入力データの存在しない命令コードを指定した場合は nullptr を返し、引数 dataSize には 0 が設定される。

サポートされていない命令コードを指定した場合は、実際の入力データが存在するか否かに関わらず例外が送出される。

const void* amdaemon::UsbIOUniqueInput::getRaw ( ) const

生の RESERVE 領域値を取得する。

USB I/O 入力情報の RESERVE 領域値を加工せずそのまま返す。ユニークコマンドによる入力機能を提供する基板は、この領域に入力情報を返す。

通常は、この関数ではなくメンバ関数 get を用いること。

const std::size_t amdaemon::UsbIOUniqueInput::RawDataSize

static

RESERVE 領域サイズ。

このクラス詳解は次のファイルから抽出されました: