qrk::mConnection Class Reference

モニタ対応の通信インターフェース More...

#include <mConnection.h>

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

List of all members.

Public Member Functions

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

Private Member Functions

 mConnection (const mConnection &rhs)
 mConnection (void)
mConnectionoperator= (const mConnection &rhs)

Private Attributes

const std::auto_ptr< pImpl > pimpl

Detailed Description

モニタ対応の通信インターフェース

Definition at line 18 of file mConnection.h.


Constructor & Destructor Documentation

qrk::mConnection::mConnection ( void   )  [private]
qrk::mConnection::mConnection ( const mConnection rhs  )  [private]
qrk::mConnection::mConnection ( Connection connection  )  [explicit]
qrk::mConnection::~mConnection ( void   ) 

Member Function Documentation

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

ボーレートを返す

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

Implements qrk::Connection.

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

送受信データのクリア

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

Implements qrk::Connection.

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

デバイスへの接続

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

Implements qrk::Connection.

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

切断

Implements qrk::Connection.

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

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

Implements qrk::Connection.

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

接続状態を返す

Return values:
true 接続中
false 切断中

Implements qrk::Connection.

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

受信

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

Implements qrk::Connection.

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

送信

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

Implements qrk::Connection.

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

ボーレートの変更

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

Implements qrk::Connection.

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

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

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

Implements qrk::Connection.

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

1文字書き戻す

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

Implements qrk::Connection.

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

内部状態を返す

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

Implements qrk::Connection.


Member Data Documentation

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

Definition at line 19 of file mConnection.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