qrk::SerialDevice Class Reference

シリアル通信クラス More...

#include <SerialDevice.h>

Inheritance diagram for qrk::SerialDevice:

List of all members.

Public Types
enum	{ DefaultBaudrate = 115200 }
Public Member Functions
const char *	what (void) const
	内部状態を返す
bool	connect (const char *device, long baudrate=DefaultBaudrate)
	デバイスへの接続
void	disconnect (void)
	切断
bool	setBaudrate (long baudrate)
	ボーレートの変更
long	baudrate (void) const
	ボーレートを返す
bool	isConnected (void) const
	接続状態を返す
int	send (const char *data, size_t count)
	送信
int	receive (char *data, size_t count, int timeout)
	受信
size_t	size (void) const
	受信済みデータのバイト数を返す
void	flush (void)
	バッファの内容を強制的に出力する
void	clear (void)
	送受信データのクリア
void	ungetc (const char ch)
	１文字書き戻す

---

Detailed Description

シリアル通信クラス

Examples:

scip_20_cr.cpp, scip_20_gd.cpp, scip_20_ii.cpp, scip_20_md.cpp, scip_20_pp.cpp, scip_20_scip.cpp, scip_20_ss.cpp, scip_20_tm.cpp, and scip_20_vv.cpp.

Definition at line 20 of file SerialDevice.h.

---

Member Function Documentation

const char * SerialDevice::what

(

void

)

const [virtual]

内部状態を返す

Returns:

内部状態を示す文字列

Implements qrk::Connection.

Examples:

scip_20_cr.cpp, scip_20_gd.cpp, scip_20_ii.cpp, scip_20_md.cpp, scip_20_pp.cpp, scip_20_scip.cpp, scip_20_ss.cpp, scip_20_tm.cpp, and scip_20_vv.cpp.

Definition at line 106 of file SerialDevice.cpp.

bool SerialDevice::connect	(	const char *	device,
		long	baudrate = DefaultBaudrate
	)		[virtual]

デバイスへの接続

Parameters:

[in]	device	接続デバイス名
[in]	baudrate	接続ボーレート

Return values:

true	成功
false	失敗

Implements qrk::Connection.

Examples:

scip_20_cr.cpp, scip_20_gd.cpp, scip_20_ii.cpp, scip_20_md.cpp, scip_20_pp.cpp, scip_20_scip.cpp, scip_20_ss.cpp, scip_20_tm.cpp, and scip_20_vv.cpp.

Definition at line 112 of file SerialDevice.cpp.

void SerialDevice::disconnect

(

void

)

[virtual]

切断

Implements qrk::Connection.

Definition at line 125 of file SerialDevice.cpp.

bool SerialDevice::setBaudrate

(

long

baudrate

)

[virtual]

ボーレートの変更

Parameters:

[in]

baudrate

ボーレート

Return values:

0	正常
<	0 エラー

Implements qrk::Connection.

Examples:

scip_20_ss.cpp.

Definition at line 131 of file SerialDevice.cpp.

long SerialDevice::baudrate

(

void

)

const [virtual]

ボーレートを返す

Return values:

ボーレート

Attention:

SerialDevice でのみ有効

Implements qrk::Connection.

Definition at line 143 of file SerialDevice.cpp.

bool SerialDevice::isConnected

(

void

)

const [virtual]

接続状態を返す

Return values:

true	接続中
false	切断中

Implements qrk::Connection.

Definition at line 149 of file SerialDevice.cpp.

int SerialDevice::send	(	const char *	data,
		size_t	count
	)		[virtual]

送信

Parameters:

[in]	data	送信データ
[in]	count	送信バイト数

Returns:

送信したバイト数

Implements qrk::Connection.

Examples:

scip_20_cr.cpp, scip_20_gd.cpp, scip_20_ii.cpp, scip_20_md.cpp, scip_20_pp.cpp, scip_20_scip.cpp, scip_20_ss.cpp, scip_20_tm.cpp, and scip_20_vv.cpp.

Definition at line 155 of file SerialDevice.cpp.

int SerialDevice::receive	(	char *	data,
		size_t	count,
		int	timeout
	)		[virtual]

受信

Parameters:

[out]	data	受信用バッファ
[in]	count	受信バッファの最大サイズ
[in]	timeout	タイムアウト時間 [msec]

Implements qrk::Connection.

Examples:

scip_20_scip.cpp.

Definition at line 170 of file SerialDevice.cpp.

size_t SerialDevice::size

(

void

)

const [virtual]

受信済みデータのバイト数を返す

Returns:

受信済みデータのバイト数

Implements qrk::Connection.

Definition at line 181 of file SerialDevice.cpp.

void SerialDevice::flush

(

void

)

[virtual]

バッファの内容を強制的に出力する

Implements qrk::Connection.

Examples:

scip_20_ss.cpp.

Definition at line 188 of file SerialDevice.cpp.

void SerialDevice::clear

(

void

)

[virtual]

送受信データのクリア

送信バッファ、受信済みデータをクリアする

Implements qrk::Connection.

Definition at line 199 of file SerialDevice.cpp.

void SerialDevice::ungetc

(

const char

ch

)

[virtual]

１文字書き戻す

Parameters:

[in]

ch

書き戻す文字

Implements qrk::Connection.

Definition at line 206 of file SerialDevice.cpp.

---

The documentation for this class was generated from the following files:

• libs/connection/SerialDevice.h
• libs/connection/SerialDevice.cpp