RS232Cアクセスクラス [詳解]

#include <TnbRs232c.h>

CRs232c の継承関係図

クラス
class	CPort
	RS232C ポート管理 [詳解]

struct	TDevice
	デバイス情報 [詳解]

公開型
enum	{ LOW = true , HI = false }
	信号線状態. [詳解]

enum	EParity { Parity_Non = NOPARITY , Parity_Odd = ODDPARITY , Parity_Even = EVENPARITY , Parity_Mark = MARKPARITY , Parity_Space = SPACEPARITY }
	パリティ設定値 [詳解]

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

enum	EStopBits { StopBits_1 = ONESTOPBIT , StopBits_1_5 = ONE5STOPBITS , StopBits_2 = TWOSTOPBITS }
	ストップビット設定値 [詳解]

typedef CVectorT< TDevice >	TDeviceVector
	デバイス情報配列. [詳解]

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

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

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

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

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

HANDLE	GetHandle (void) const
	[取得] ハンドル取得 [詳解]

void	GetParameter (CPort &_comPort, DWORD &_dwBaudRate, BYTE &_bByteSize, EParity &_eParity, EStopBits &_eStopBits) const
	[取得] オープン設定取得. [詳解]

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

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

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

bool	IsCtsSignalLow (void) const
	[取得] CTS 確認. [詳解]

bool	IsCtsSignalOn (void) const
	[取得] CTS 確認. [詳解]

bool	IsDsrSignalLow (void) const
	[取得] DSR 確認. [詳解]

bool	IsDsrSignalOn (void) const
	[取得] DSR 確認. [詳解]

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

bool	IsRingSignalLow (void) const
	[取得] RING 確認. [詳解]

bool	IsRingSignalOn (void) const
	[取得] RING 確認. [詳解]

bool	IsRlsdSignalLow (void) const
	[取得] RLSD 確認. [詳解]

bool	IsRlsdSignalOn (void) const
	[取得] RLSD 確認. [詳解]

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

bool	PaddingReceive (DWORD dwTime)
	[操作] パディング読み込み [詳解]

virtual void	Purge (void)
	[設定] パージ. [詳解]

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

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

void	SetCheckCtsMode (bool r=true)
	[設定] CTSチェック設定. [詳解]

bool	SetDtrSignal (bool isLow)
	[設定] DTR 設定. [詳解]

DWORD	SetParameter (CPort comPort, DWORD dwBaudRate, BYTE bByteSize, EParity eParity, EStopBits eStopBits)
	[設定] オープン設定. [詳解]

virtual bool	SetReceiveTimeout (DWORD to)
	[設定] 受信待ち時間設定. [詳解]

bool	SetRtsSignal (bool isLow)
	[設定] RTS 設定. [詳解]

void	SetSendMode (bool canBulk)
	[設定] 送信設定. [詳解]

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

静的公開メンバ関数
static DWORD	CanPortBeOpened (CPort comPort)
	[確認] 指定ポートは開けるか [詳解]

static TDeviceVector	EnumExistPortDeviceNames (void)
	[取得] 存在するPort一覧 [詳解]

static CWordVector	EnumExistPorts (void)
	[取得] 存在するPort一覧 [詳解]

static CWordVector	EnumExistPortsByUsb (WORD vid, WORD pid)
	[取得] USBシリアルPort一覧. [詳解]

限定公開メンバ関数
virtual HANDLE	CreatePort (LPCTSTR lpszPortName) const
	[通知] ポート作成. [詳解]

virtual bool	OnRs232cOpening (HANDLE hComPort, DCB &_tDCB, COMMTIMEOUTS &_tCommTimeOuts)
	[通知] オープン通知. [詳解]

virtual bool	ReadPort (size_t &_redSize, LPVOID _P, size_t len, HANDLE h) const
	[通知] ポート読み込み. [詳解]

virtual bool	WritePort (size_t &_writtenSize, size_t len, LPCVOID P, HANDLE h) const
	[通知] ポート書き込み. [詳解]

詳解

RS232Cアクセスクラス

シリアルアクセスを行うクラスです。

覚え書き: 通信設定は、 SetParameter() を使って指定します。より細かい設定は、本クラスを継承し、 OnRs232cOpening() を実装します。受信バッファサイズの変更は Win32API の ::SetupComm() を使用します。

必要ファイル: TnbRs232c.h

日付: 06/01/01 新規作成; 06/05/11 ICommunication 実装; 06/07/14 Open時デフォルトでフローOFF設定を行なうようにした。 CTS信号によるConnect/Disconnectイベントを上げるようにした。 IsConnect()メソッドを追加。; 06/08/31 CommViewer に対応。; 06/09/08 Purge() / IsAlive() / IsConnect() 追加。 CanAccess() 廃止。; 07/02/09 親クラス変更。; 07/06/11 親クラスの Start() メソッドに対応。; 07/09/13 親クラスの変更。; 08/11/07 OnRs232cOpening() メソッド追加。; 09/10/01 構成。 GetParameter() 追加。; 09/10/22 ポートを文字列指定可能に。; 09/11/11 SetParameter() の仕様拡張。; 10/02/17 EnumExistPortDeviceNames() 追加。; 10/05/28 SetReceiveTimeout() を実装。; 10/06/29 SetReceiveTimeout() をダミー化。信号線制御メソッド用意。; 11/02/03 SetCheckCtsMode() のデフォルトを false に。; 11/03/15 Close() 後もプロパティのタイプID,名を変更しないようにした。; 11/07/12 信号線操作メソッドの改修。; 12/02/17 EnumExistPortDeviceNames() で USB の VID, PID の値も得られるようにした。; 12/10/22 EnumExistPortsByUsb() を新規。; 14/07/30 EnumExist〜() の結果を sort するようにした。

TnbRs232c.h の 71 行目に定義があります。

型定義メンバ詳解

◆ TDeviceVector

typedef CVectorT<TDevice> TDeviceVector

デバイス情報配列.

TnbRs232c.h の 867 行目に定義があります。

列挙型メンバ詳解

◆ anonymous enum

anonymous enum

信号線状態.

列挙値
LOW	LOW (ON)
HI	HI (OFF)

TnbRs232c.h の 632 行目に定義があります。

◆ EParity

enum EParity

パリティ設定値

列挙値
Parity_Non	なしパリティ
Parity_Odd	奇数パリティ
Parity_Even	偶数パリティ
Parity_Mark	マークパリティ
Parity_Space	空白パリティ

TnbRs232c.h の 194 行目に定義があります。

◆ EState

enum EState

inherited

状態

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

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

◆ EStopBits

enum EStopBits

ストップビット設定値

列挙値
StopBits_1	1bit
StopBits_1_5	1.5bit
StopBits_2	2bit

TnbRs232c.h の 211 行目に定義があります。

構築子と解体子

◆ CRs232c()

CRs232c ( void )

コンストラクタ

TnbRs232c.h の 229 行目に定義があります。

◆ ~CRs232c()

~CRs232c ( void )

デストラクタ

TnbRs232c.h の 237 行目に定義があります。

関数詳解

◆ CanPortBeOpened()

static DWORD CanPortBeOpened ( CPort comPort )

static

[確認] 指定ポートは開けるか

引数

comPort COMポートナンバー。数値でも文字列でも指定可能です。

戻り値

0	成功。
0以外	エラー。数値はシステムエラーコードです( SystemErrorToMessageText() で文字列化できます)。

TnbRs232c.h の 802 行目に定義があります。

◆ CanReceive()

virtual bool CanReceive ( void ) const

virtualinherited

[確認] 受信可能確認.

戻り値

true	受信可能。
false	不可能。

CCeUsbHid, CFileCommunicator, CVmRs232c, CUsbHidで再実装されています。

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

◆ CanSend()

virtual bool CanSend ( void ) const

virtualinherited

[確認] 送信可能確認.

戻り値

true	送信可能。
false	不可能。

CCeUsbHid, CFileCommunicator, CVmRs232c, CUsbHidで再実装されています。

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

◆ Check()

virtual EState Check ( void ) const

virtual

[確認] チェック.

状態を確認します。定期的に呼び出す必要があります。

覚え書き: CONNECTING は、 CTS 信号により判断しますので、 SetCheckCtsMode() で true を指定している必要があります。

戻り値

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

ICommunicationを再実装しています。

TnbRs232c.h の 432 行目に定義があります。

◆ Close()

virtual void Close ( void )

virtual

[処理] クローズ.

ICommunicationを実装しています。

CBluetoothCom, CRs232cExで再実装されています。

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

◆ CreatePort()

virtual HANDLE CreatePort ( LPCTSTR lpszPortName ) const

protectedvirtual

[通知] ポート作成.

ポート作成時、コールされます。

引数

lpszPortName ポート名

戻り値

INVALID_HANDLE_VALUE	失敗。
上記以外	成功。値はハンドル。使用後は CloseHandle() してください。

CRs232cExで再実装されています。

TnbRs232c.h の 954 行目に定義があります。

◆ EnumExistPortDeviceNames()

static TDeviceVector EnumExistPortDeviceNames ( void )

static

[取得] 存在するPort一覧

戻り値: 存在するポートNo、名前一覧（Sizeが２でport内容が 1,4 なら "COM1" "COM4"が使用可能）

TnbRs232c.h の 873 行目に定義があります。

◆ EnumExistPorts()

static CWordVector EnumExistPorts ( void )

static

[取得] 存在するPort一覧

戻り値: 存在するポートNo一覧（Sizeが２で内容が 1,4 なら "COM1" "COM4"が使用可能）

TnbRs232c.h の 884 行目に定義があります。

◆ EnumExistPortsByUsb()

static CWordVector EnumExistPortsByUsb	(	WORD	vid,
		WORD	pid
	)

static

[取得] USBシリアルPort一覧.

引数

vid	VendorID (USB)
pid	ProductID (USB)

戻り値: 存在するポートNo一覧（Sizeが２で内容が 1,4 なら "COM1" "COM4"が使用可能）

TnbRs232c.h の 913 行目に定義があります。

◆ GetHandle()

HANDLE GetHandle ( void ) const

[取得] ハンドル取得

戻り値

NULL	オープンしていない。
NULL以外	ハンドル

TnbRs232c.h の 339 行目に定義があります。

◆ GetParameter()

void GetParameter	(	CPort &	_comPort,
		DWORD &	_dwBaudRate,
		BYTE &	_bByteSize,
		EParity &	_eParity,
		EStopBits &	_eStopBits
	)		const

[取得] オープン設定取得.

SetParameter() で設定した値を取得できます。

引数

[out]	_comPort	ポートナンバー。
[out]	_dwBaudRate	転送速度[bps]
[out]	_bByteSize	キャラクタビット[bits]
[out]	_eParity	パリティ（偶数／奇数）
[out]	_eStopBits	ストップビット[bits]

TnbRs232c.h の 251 行目に定義があります。

◆ GetProperty()

virtual const TProperty & GetProperty ( void ) const

virtual

[取得] 性能取得

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

戻り値: 性能情報

ICommunicationを実装しています。

CRs232cExで再実装されています。

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

◆ GetReceivingDataSize()

virtual size_t GetReceivingDataSize ( void ) const

virtual

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

戻り値

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

ICommunicationを再実装しています。

TnbRs232c.h の 410 行目に定義があります。

◆ IsConnect()

virtual bool IsConnect ( void ) const

virtual

[確認] 接続確認.

覚え書き: Check() の結果を返します。

戻り値

true	接続中。
false	切断中。

ICommunicationを再実装しています。

TnbRs232c.h の 400 行目に定義があります。

◆ IsCtsSignalLow()

bool IsCtsSignalLow ( void ) const

[取得] CTS 確認.

CTS(clear-to-send)信号の状態を確認します。

覚え書き: JIS での名称は「CS（送信可）」。

クロスケーブルの場合: RTS(7) ----------> CTS(8)

CTS(8) <---------- RTS(7)

戻り値

true	LOW(ON)
false	HI(OFF)

TnbRs232c.h の 686 行目に定義があります。

◆ IsCtsSignalOn()

bool IsCtsSignalOn ( void ) const

[取得] CTS 確認.

覚え書き: IsCtsSignalLow() を使用してください。

戻り値

true	ON(LOW)
false	OFF(HI)

TnbRs232c.h の 758 行目に定義があります。

◆ IsDsrSignalLow()

bool IsDsrSignalLow ( void ) const

[取得] DSR 確認.

DSR(data-set-ready)信号の状態を確認します。

覚え書き: JIS での名称は「DR（データセットレディ）」。

クロスケーブルの場合: DTR(4) ----------> DSR(6)

DSR(6) <---------- DTR(4)

戻り値

true	LOW(ON)
false	HI(OFF)

TnbRs232c.h の 708 行目に定義があります。

◆ IsDsrSignalOn()

bool IsDsrSignalOn ( void ) const

[取得] DSR 確認.

覚え書き: IsDsrSignalLow() を使用してください。

戻り値

true	ON(LOW)
false	OFF(HI)

TnbRs232c.h の 769 行目に定義があります。

◆ IsOpened()

virtual bool IsOpened ( void ) const

virtual

[確認] オープン確認.

戻り値

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

ICommunicationを実装しています。

TnbRs232c.h の 389 行目に定義があります。

◆ IsRingSignalLow()

bool IsRingSignalLow ( void ) const

[取得] RING 確認.

RING 信号の状態を確認します。

覚え書き: 別表記として「RI」。

戻り値

true	LOW(ON)
false	HI(OFF)

TnbRs232c.h の 725 行目に定義があります。

◆ IsRingSignalOn()

bool IsRingSignalOn ( void ) const

[取得] RING 確認.

覚え書き: IsRingSignalLow() を使用してください。

戻り値

true	ON(LOW)
false	OFF(HI)

TnbRs232c.h の 780 行目に定義があります。

◆ IsRlsdSignalLow()

bool IsRlsdSignalLow ( void ) const

[取得] RLSD 確認.

RLSD(receive-line-signal-detect)信号の状態を確認します。

覚え書き: 別表記として「DCD」。

戻り値

true	LOW(ON)
false	HI(OFF)

TnbRs232c.h の 742 行目に定義があります。

◆ IsRlsdSignalOn()

bool IsRlsdSignalOn ( void ) const

[取得] RLSD 確認.

覚え書き: IsRlsdSignalLow() を使用してください。

戻り値

true	ON(LOW)
false	OFF(HI)

TnbRs232c.h の 791 行目に定義があります。

◆ OnRs232cOpening()

virtual bool OnRs232cOpening	(	HANDLE	hComPort,
		DCB &	_tDCB,
		COMMTIMEOUTS &	_tCommTimeOuts
	)

protectedvirtual

[通知] オープン通知.

オープン時、コールされます。

引数

[in]	hComPort	ハンドル
[in,out]	_tDCB	現在の DCB が渡されます。変更することで設定を変更できます。
[in,out]	_tCommTimeOuts	現在の COMMTIMEOUTS が渡されます。変更することで設定を変更できます。

戻り値

true	オープン処理継続。
false	オープン処理中止（Openが失敗します）。

CRs232cHfで再実装されています。

TnbRs232c.h の 942 行目に定義があります。

◆ Open()

virtual bool Open ( void )

virtual

[処理] オープン.

戻り値

true	成功。
false	失敗。

ICommunicationを実装しています。

CBluetoothCom, CRs232cExで再実装されています。

TnbRs232c.h の 349 行目に定義があります。

◆ PaddingReceive()

bool PaddingReceive ( DWORD dwTime )

[操作] パディング読み込み

覚え書き: オープンしているポートで空読み込みをします。

引数

dwTime 受信情報なしの時間指定。

戻り値

true	成功
false	失敗

TnbRs232c.h の 570 行目に定義があります。

◆ Purge()

virtual void Purge ( void )

virtual

[設定] パージ.

通信のゴミを浄化

ICommunicationを再実装しています。

TnbRs232c.h の 558 行目に定義があります。

◆ ReadPort()

virtual bool ReadPort	(	size_t &	_redSize,
		LPVOID	_P,
		size_t	len,
		HANDLE	h
	)		const

protectedvirtual

[通知] ポート読み込み.

ポート読み込み時、コールされます。

引数

[out]	_redSize	書き込んだサイズが格納されます。
[out]	_P	読み込みデータが格納されます。
[in]	len	読み込みデータ最大
[in]	h	ハンドル

戻り値

true	成功
false	失敗

CRs232cExで再実装されています。

TnbRs232c.h の 995 行目に定義があります。

◆ Receive()

virtual size_t Receive	(	size_t	size,
		LPVOID	_P
	)

virtual

[処理] 受信.

引数

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

戻り値

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

ICommunicationを実装しています。

CRs232cExで再実装されています。

TnbRs232c.h の 529 行目に定義があります。

◆ Send()

virtual size_t Send	(	size_t	size,
		LPCVOID	P
	)

virtual

[処理] 送信.

引数

size	サイズ。
P	データ。

戻り値

INVALID_SIZE	エラー。
上記以外	送信データサイズ。０の可能性もあります。

ICommunicationを実装しています。

TnbRs232c.h の 462 行目に定義があります。

◆ SetCheckCtsMode()

void SetCheckCtsMode ( bool r = true )

[設定] CTSチェック設定.

CTS信号が立っている時だけ接続とするモードと、CTS信号を無視するモードを選択できます。

引数

r	ture なら CTS信号をチェックします。デフォルトはチェックしません。

TnbRs232c.h の 319 行目に定義があります。

◆ SetDtrSignal()

bool SetDtrSignal ( bool isLow )

[設定] DTR 設定.

DTR(data-terminal-ready)信号の状態を設定します。

覚え書き: JIS での名称は「ER（データ端末レディ）」。

クロスケーブルの場合: DTR(4) ----------> DSR(6)

DSR(6) <---------- DTR(4)

引数

isLow 状態。 CRs232c::LOW か CRs232c::HI を指定。

戻り値

true	成功
false	失敗

TnbRs232c.h の 651 行目に定義があります。

◆ SetParameter()

DWORD SetParameter	(	CPort	comPort,
		DWORD	dwBaudRate,
		BYTE	bByteSize,
		EParity	eParity,
		EStopBits	eStopBits
	)

[設定] オープン設定.

RS232Cの設定を行います。通常、 Open の前に使用します。

覚え書き: Open 前に実行した場合必ず成功します。; オープン中、本メソッドでCOMポートナンバーを変更した場合、クローズされます。; オープン中、本メソッドを使用した場合、エラーになる可能性もあります。

引数

comPort	COMポートナンバー。数値でも文字列でも指定可能です。
dwBaudRate	転送速度[bps]
bByteSize	キャラクタビット[bits]
eParity	パリティ（偶数／奇数）
eStopBits	ストップビット[bits]

戻り値

0	成功。
0以外	エラー。数値はシステムエラーコードです( SystemErrorToMessageText() で文字列化できます)。

TnbRs232c.h の 274 行目に定義があります。

◆ SetReceiveTimeout()

virtual bool SetReceiveTimeout ( DWORD to )

virtual

[設定] 受信待ち時間設定.

Receive() 実行時、受信できるデータが無い時に待つ時間を設定できます。

覚え書き: 成功すると、プロパティが変更される可能性があります。

引数

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

戻り値: false 失敗。サポートできない時もこれが返ります。

ICommunicationを実装しています。

CRs232cExで再実装されています。

TnbRs232c.h の 299 行目に定義があります。

◆ SetRtsSignal()

bool SetRtsSignal ( bool isLow )

[設定] RTS 設定.

RTS(request-to-send)信号の状態を設定します。

覚え書き: JIS での名称は「RS（送信要求）」。

クロスケーブルの場合: RTS(7) ----------> CTS(8)

CTS(8) <---------- RTS(7)

引数

isLow 状態。 CRs232c::LOW か CRs232c::HI を指定。

戻り値

true	成功
false	失敗

TnbRs232c.h の 669 行目に定義があります。

◆ SetSendMode()

void SetSendMode ( bool canBulk )

[設定] 送信設定.

送信設定をおこないます。デフォルトはバルク(一括)モードです。

引数

canBulk ture ならバルク(一括)モードで送信します。 false なら、一バイトずつ送信します。

TnbRs232c.h の 309 行目に定義があります。

◆ WritePort()

virtual bool WritePort	(	size_t &	_writtenSize,
		size_t	len,
		LPCVOID	P,
		HANDLE	h
	)		const

protectedvirtual

[通知] ポート書き込み.

ポート書き込み時、コールされます。

引数

[out]	_writtenSize	書き込んだサイズが格納されます。
[in]	len	書き込みデータサイズ
[in]	P	書き込みデータ
[in]	h	ハンドル

戻り値

true	成功
false	失敗

CRs232cExで再実装されています。

TnbRs232c.h の 973 行目に定義があります。

クラス

公開型

公開メンバ関数

静的公開メンバ関数

限定公開メンバ関数

詳解

型定義メンバ詳解

◆ TDeviceVector

列挙型メンバ詳解

◆ anonymous enum

◆ EParity

◆ EState

◆ EStopBits

構築子と解体子

◆ CRs232c()

◆ ~CRs232c()

関数詳解

◆ CanPortBeOpened()

◆ CanReceive()

◆ CanSend()

◆ Check()

◆ Close()

◆ CreatePort()

◆ EnumExistPortDeviceNames()

◆ EnumExistPorts()

◆ EnumExistPortsByUsb()

◆ GetHandle()

◆ GetParameter()

◆ GetProperty()

◆ GetReceivingDataSize()

◆ IsConnect()

◆ IsCtsSignalLow()

◆ IsCtsSignalOn()

◆ IsDsrSignalLow()

◆ IsDsrSignalOn()

◆ IsOpened()

◆ IsRingSignalLow()

◆ IsRingSignalOn()

◆ IsRlsdSignalLow()

◆ IsRlsdSignalOn()

◆ OnRs232cOpening()

◆ Open()

◆ PaddingReceive()

◆ Purge()

◆ ReadPort()

◆ Receive()

◆ Send()

◆ SetCheckCtsMode()

◆ SetDtrSignal()

◆ SetParameter()

◆ SetReceiveTimeout()

◆ SetRtsSignal()

◆ SetSendMode()

◆ WritePort()