qrk::SerialDevice Class Reference

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

#include <SerialDevice.h>

Inheritance diagram for qrk::SerialDevice:
Inheritance graph
[legend]

List of all members.

Public Types

enum  { DefaultBaudrate = 115200 }

Public Member Functions

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

Private Member Functions

SerialDeviceoperator= (const SerialDevice &rhs)
 SerialDevice (const SerialDevice &rhs)

Private Attributes

const std::auto_ptr< pImpl > pimpl

Detailed Description

シリアル通信クラス

Definition at line 22 of file SerialDevice.h.


Member Enumeration Documentation

anonymous enum
Enumerator:
DefaultBaudrate 

Definition at line 25 of file SerialDevice.h.


Constructor & Destructor Documentation

qrk::SerialDevice::SerialDevice ( void   ) 
qrk::SerialDevice::~SerialDevice ( void   ) 
qrk::SerialDevice::SerialDevice ( const SerialDevice rhs  )  [private]

Member Function Documentation

long qrk::SerialDevice::baudrate ( void   )  const [virtual]

ボーレートを返す

Return values:
ボーレート 
Attention:
SerialDevice でのみ有効

Implements qrk::Connection.

void qrk::SerialDevice::clear ( void   )  [virtual]

送受信データのクリア

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

Implements qrk::Connection.

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

デバイスへの接続

Parameters:
[in] device 接続デバイス名
[in] baudrate 接続ボーレート
Return values:
true 成功
false 失敗

Implements qrk::Connection.

void qrk::SerialDevice::disconnect ( void   )  [virtual]

切断

Implements qrk::Connection.

void qrk::SerialDevice::flush ( void   )  [virtual]

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

Implements qrk::Connection.

bool qrk::SerialDevice::isConnected ( void   )  const [virtual]

接続状態を返す

Return values:
true 接続中
false 切断中

Implements qrk::Connection.

SerialDevice& qrk::SerialDevice::operator= ( const SerialDevice rhs  )  [private]
int qrk::SerialDevice::receive ( char *  data,
size_t  count,
int  timeout 
) [virtual]

受信

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

Implements qrk::Connection.

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

送信

Parameters:
[in] data 送信データ
[in] count 送信バイト数
Returns:
送信したバイト数

Implements qrk::Connection.

bool qrk::SerialDevice::setBaudrate ( long  baudrate  )  [virtual]

ボーレートの変更

Parameters:
[in] baudrate ボーレート
Return values:
0 正常
< 0 エラー

Implements qrk::Connection.

size_t qrk::SerialDevice::size ( void   )  const [virtual]

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

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

Implements qrk::Connection.

void qrk::SerialDevice::ungetc ( const char  ch  )  [virtual]

1文字書き戻す

Parameters:
[in] ch 書き戻す文字

Implements qrk::Connection.

const char* qrk::SerialDevice::what ( void   )  const [virtual]

内部状態を返す

Returns:
内部状態を示す文字列

Implements qrk::Connection.


Member Data Documentation

const std::auto_ptr<pImpl> qrk::SerialDevice::pimpl [private]

Definition at line 49 of file SerialDevice.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Friends Defines


libhokuyo_urg
Author(s): Alexander Bubeck
autogenerated on Fri Jan 11 09:14:15 2013