USB-HIDアクセスクラス(CE専用) [詳解]

#include <TnbCeUsbHid.h>

CCeUsbHid の継承関係図

クラス
struct	TIoCtrlBlock_CheckDevice
	デバイスチェック. [詳解]

struct	TIoCtrlBlock_GetString
	文字列取得. [詳解]

struct	TIoCtrlBlock_Read
	読み込み. [詳解]

struct	TIoCtrlBlock_Write
	書き込み. [詳解]

公開型
enum	EState { OPENNING , CONNECTING , CLOSED }
	状態 [詳解]

enum	EStringType { INDEXED = 0 , MANUFACTURER , PRODUCT , SERIALNUMBER }
	文字タイプ [詳解]

公開メンバ関数
virtual bool	CanReceive (void) const
	[確認] 受信可能確認. [詳解]

virtual bool	CanSend (void) const
	[確認] 送信可能確認. [詳解]

	CCeUsbHid (void)
	コンストラクタ [詳解]

virtual EState	Check (void) const
	[確認] チェック. [詳解]

virtual void	Close (void)
	[処理] クローズ. [詳解]

const TIoCtrlBlock_CheckDevice &	GetDeviceInfo (void) const
	[取得] デバイス情報取得 [詳解]

virtual const TProperty &	GetProperty (void) const
	[取得] 性能取得. [詳解]

virtual size_t	GetReceivingDataSize (void) const
	[確認] 受信データ確認. [詳解]

CStr	GetString (EStringType type, INDEX index=0) const
	[取得] 文字列取得. [詳解]

virtual bool	IsConnect (void) const
	[確認] 接続確認. [詳解]

virtual bool	IsOpened (void) const
	[確認] オープン確認. [詳解]

virtual bool	Open (void)
	[処理] オープン. [詳解]

virtual void	Purge (void)
	[処理] パージ. [詳解]

virtual size_t	Receive (size_t size, LPVOID _P)
	[処理] 受信. [詳解]

virtual size_t	Send (size_t size, LPCVOID P)
	[処理] 送信. [詳解]

void	SetDeviceIndex (int i)
	[設定] デバイスインデックス設定. [詳解]

bool	SetReceiveTimeout (DWORD to)
	[設定] 受信タイムアウト時間設定. [詳解]

virtual	~CCeUsbHid (void)
	デストラクタ [詳解]

静的公開メンバ関数
static bool	RegistDriver (WORD vendorId=0x20FC, WORD productId=1, WORD usagePage=0xFF00, WORD usageId=1, LPCTSTR lpszDriverName=_T("USBHID_T.DLL"))
	[設定] ドライバーレジストリ登録. [詳解]

詳解

USB-HIDアクセスクラス(CE専用)

専用のデバイスドライバ（USBHID_T.DLL）を使った HID デバイスの入出力をサポートします。

覚え書き: 専用のデバイスドライバのレジストリ登録を行うメソッドも用意しています。→ RegistDriver()

必要ファイル: TnbCeUsbHid.h

日付: 10/03/11 新規作成; 11/06/15 ライブラリへ追加

TnbCeUsbHid.h の 55 行目に定義があります。

列挙型メンバ詳解

◆ EState

enum EState

inherited

状態

列挙値
OPENNING	オープン状態
CONNECTING	オープン＆接続状態
CLOSED	クローズ状態

TnbCommunication.h の 38 行目に定義があります。

◆ EStringType

enum EStringType

文字タイプ

覚え書き: GetString() の第一引数で使用します。

列挙値
INDEXED	String Index.
MANUFACTURER	Manufacturer identifer.
PRODUCT	Product identifer.
SERIALNUMBER	Serial number.

TnbCeUsbHid.h の 146 行目に定義があります。

構築子と解体子

◆ CCeUsbHid()

CCeUsbHid ( void )

explicit

コンストラクタ

TnbCeUsbHid.h の 159 行目に定義があります。

◆ ~CCeUsbHid()

virtual ~CCeUsbHid ( void )

virtual

デストラクタ

TnbCeUsbHid.h の 165 行目に定義があります。

関数詳解

◆ CanReceive()

virtual bool CanReceive ( void ) const

virtual

[確認] 受信可能確認.

戻り値

true	受信可能。
false	不可能。

ICommunicationを再実装しています。

TnbCeUsbHid.h の 277 行目に定義があります。

◆ CanSend()

virtual bool CanSend ( void ) const

virtual

[確認] 送信可能確認.

戻り値

true	送信可能。
false	不可能。

ICommunicationを再実装しています。

TnbCeUsbHid.h の 267 行目に定義があります。

◆ Check()

virtual EState Check ( void ) const

virtual

[確認] チェック.

状態を確認します。

戻り値

CONNECTING	オープン＆接続状態
CLOSED	クローズ状態

ICommunicationを再実装しています。

TnbCeUsbHid.h の 364 行目に定義があります。

◆ Close()

virtual void Close ( void )

virtual

[処理] クローズ.

ICommunicationを実装しています。

TnbCeUsbHid.h の 232 行目に定義があります。

◆ GetDeviceInfo()

const TIoCtrlBlock_CheckDevice & GetDeviceInfo ( void ) const

[取得] デバイス情報取得

覚え書き: Openしていない時の戻り値は不定です。

戻り値: デバイス情報

TnbCeUsbHid.h の 405 行目に定義があります。

◆ GetProperty()

virtual const TProperty & GetProperty ( void ) const

virtual

[取得] 性能取得.

覚え書き: 正確な情報は Open後に取得できます。

戻り値: 性能情報

ICommunicationを実装しています。

TnbCeUsbHid.h の 186 行目に定義があります。

◆ GetReceivingDataSize()

virtual size_t GetReceivingDataSize ( void ) const

virtual

[確認] 受信データ確認.

戻り値

INVALID_SIZE	不明。
上記以外	受信可能データサイズ。

ICommunicationを再実装しています。

TnbCeUsbHid.h の 353 行目に定義があります。

◆ GetString()

CStr GetString	(	EStringType	type,
		INDEX	index = `0`
	)		const

[取得] 文字列取得.

引数

type	文字タイプ.
index	文字タイプが INDEXED の場合、指定必須。１以上。

戻り値

Empty	エラー。
上記以外	成功。文字列は取得した文字列。

TnbCeUsbHid.h の 382 行目に定義があります。

◆ IsConnect()

virtual bool IsConnect ( void ) const

virtual

[確認] 接続確認.

戻り値

true	接続中。
false	切断中。

ICommunicationを再実装しています。

TnbCeUsbHid.h の 257 行目に定義があります。

◆ IsOpened()

virtual bool IsOpened ( void ) const

virtual

[確認] オープン確認.

戻り値

true	オープン中。
false	クローズ中。

ICommunicationを実装しています。

TnbCeUsbHid.h の 247 行目に定義があります。

◆ Open()

virtual bool Open ( void )

virtual

[処理] オープン.

戻り値

true	成功。
false	失敗。

ICommunicationを実装しています。

TnbCeUsbHid.h の 196 行目に定義があります。

◆ Purge()

virtual void Purge ( void )

virtual

[処理] パージ.

通信のゴミを浄化

ICommunicationを再実装しています。

TnbCeUsbHid.h の 373 行目に定義があります。

◆ Receive()

virtual size_t Receive	(	size_t	size,
		LPVOID	_P
	)

virtual

[処理] 受信.

引数

[in]	size	サイズ。
[out]	_P	データ。size 分のメモリは確保しておく必要があります。

戻り値

INVALID_SIZE	エラー。
0	受信データなし。
上記以外	受信データサイズ。

ICommunicationを実装しています。

TnbCeUsbHid.h の 329 行目に定義があります。

◆ RegistDriver()

static bool RegistDriver	(	WORD	vendorId = `0x20FC`,
		WORD	productId = `1`,
		WORD	usagePage = `0xFF00`,
		WORD	usageId = `1`,
		LPCTSTR	lpszDriverName = `_T("USBHID_T.DLL")`
	)

static

[設定] ドライバーレジストリ登録.

引数

vendorId	ベンダーID
productId	プロダクトID
usagePage	USAGEページ
usageId	USAGE ID
lpszDriverName	ドライバーDLL名

戻り値

true	成功
false	失敗.そのドライバーDLLが見つからない

TnbCeUsbHid.h の 420 行目に定義があります。

◆ Send()

virtual size_t Send	(	size_t	size,
		LPCVOID	P
	)

virtual

[処理] 送信.

覚え書き: OutputReport長で割り切れないデータサイズを渡すと、足りないところは０でPaddingされます。

引数

size	サイズ。
P	データ。

戻り値

INVALID_SIZE	エラー。
上記以外	送信データサイズ。

ICommunicationを実装しています。

TnbCeUsbHid.h の 302 行目に定義があります。

◆ SetDeviceIndex()

void SetDeviceIndex ( int i )

[設定] デバイスインデックス設定.

デフォルトでは１です。通常、変更する必要はありません。

覚え書き: Open() の前に使用してください。

引数

i	デバイスインデックス

TnbCeUsbHid.h の 176 行目に定義があります。

◆ SetReceiveTimeout()

bool SetReceiveTimeout ( DWORD to )

virtual

[設定] 受信タイムアウト時間設定.

覚え書き: 未設定時は 100ms です。

引数

to	タイムアウト時間(ms)。

戻り値: true 固定

ICommunicationを実装しています。

TnbCeUsbHid.h の 288 行目に定義があります。

クラス

公開型

公開メンバ関数

静的公開メンバ関数

詳解

列挙型メンバ詳解

◆ EState

◆ EStringType

構築子と解体子

◆ CCeUsbHid()

◆ ~CCeUsbHid()

関数詳解

◆ CanReceive()

◆ CanSend()

◆ Check()

◆ Close()

◆ GetDeviceInfo()

◆ GetProperty()

◆ GetReceivingDataSize()

◆ GetString()

◆ IsConnect()

◆ IsOpened()

◆ Open()

◆ Purge()

◆ Receive()

◆ RegistDriver()

◆ Send()

◆ SetDeviceIndex()

◆ SetReceiveTimeout()