amdaemon::UsbIOGeneralOutput クラス

USB I/O の汎用出力処理を行うクラス。 [詳解]

#include <UsbIOGeneralOutput.h>

公開メンバ関数
	UsbIOGeneralOutput (InnerIndexHolder)
	コンストラクタ。 [詳解]
RequestState	setBits (std::uint64_t bits, bool forceUpdate=false)
	出力するビット列を設定する。 [詳解]
RequestState	resetBits (bool forceUpdate=false)
	出力するビット列をリセットする。 [詳解]
RequestState	setBit (std::size_t bitIndex, bool on, bool forceUpdate=false)
	出力するビット値を設定する。 [詳解]
std::uint64_t	getCurrentBits () const
	現在設定されているビット列を取得する。 [詳解]

静的公開変数類
static const std::size_t	MaxBitCount
	最大有効ビット数。 [詳解]

詳解

USB I/O の汎用出力処理を行うクラス。

参照

UsbIO, UsbIONode

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

構築子と解体子

amdaemon::UsbIOGeneralOutput::UsbIOGeneralOutput ( InnerIndexHolder  )

explicit

コンストラクタ。

覚え書き

アプリ側からは利用できない。

関数詳解

RequestState amdaemon::UsbIOGeneralOutput::setBits	(	std::uint64_t	bits,
		bool	forceUpdate = false
	)

出力するビット列を設定する。

引数

[in]	bits	出力するビット列。
[in]	forceUpdate	値が変化しない場合も更新要求するならば true 。既定値は false 。

戻り値

要求状態値。更新不要ならば無効値。

この関数を呼び出しても即座に出力されるわけではない。 反映状況は戻り値の要求状態値で確認できる。

引数 forceUpdate が false かつ値が変化しない場合、更新不要と判断される。 その場合、戻り値の要求状態値は無効値となる。

この関数を同一フレーム内で複数回呼びだした場合、 最後の呼び出し時に指定した値のみが反映される。

RequestState amdaemon::UsbIOGeneralOutput::resetBits ( bool  forceUpdate = false )

inline

出力するビット列をリセットする。

引数

[in]

forceUpdate

値が変化しない場合も更新要求するならば true 。既定値は false 。

戻り値

要求状態値。

メンバ関数 setBits を第1引数値 0 で呼び出すことと同義。

RequestState amdaemon::UsbIOGeneralOutput::setBit	(	std::size_t	bitIndex,
		bool	on,
		bool	forceUpdate = false
	)

出力するビット値を設定する。

引数

[in]	bitIndex	ビットインデックス。
[in]	on	ビットを立てるならば true 。下ろすならば false 。
[in]	forceUpdate	値が変化しない場合も更新要求するならば true 。既定値は false 。

戻り値

要求状態値。

例外

Exception

引数 bitIndex に MaxBitCount 以上の値を指定した場合。

この関数を呼び出しても即座に出力されるわけではない。 反映状況は戻り値の要求状態値で確認できる。

引数 forceUpdate が false かつ値が変化しない場合、更新不要と判断される。 その場合、戻り値の要求状態値は無効値となる。

この関数を同一フレーム内で同一ビットインデックスに対して複数回呼びだした場合、 最後の呼び出し時に指定した値のみが反映される。 異なるビットインデックスに対して呼びだした場合はマージされる。

std::uint64_t amdaemon::UsbIOGeneralOutput::getCurrentBits

(

)

const

現在設定されているビット列を取得する。

戻り値

現在設定されているビット列。

現在ライブラリ内で保持しているビット列を返す。 起動直後などは、実デバイスにこの値が設定されているとは限らない。

メンバ詳解

const std::size_t amdaemon::UsbIOGeneralOutput::MaxBitCount

static

最大有効ビット数。

---

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

• UsbIOGeneralOutput.h