qrk::Connection Class Reference

通信インターフェース More...

#include <Connection.h>

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

List of all members.

Public Member Functions

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

Detailed Description

通信インターフェース

Definition at line 26 of file Connection.h.


Constructor & Destructor Documentation

virtual qrk::Connection::~Connection ( void   )  [inline, virtual]

Definition at line 29 of file Connection.h.


Member Function Documentation

virtual long qrk::Connection::baudrate ( void   )  const [pure virtual]

ボーレートを返す

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

Implemented in qrk::mConnection, qrk::SerialDevice, and qrk::TcpipSocket.

virtual void qrk::Connection::clear ( void   )  [pure virtual]

送受信データのクリア

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

Implemented in qrk::mConnection, qrk::SerialDevice, and qrk::TcpipSocket.

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

デバイスへの接続

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

Implemented in qrk::mConnection, qrk::SerialDevice, and qrk::TcpipSocket.

virtual void qrk::Connection::disconnect ( void   )  [pure virtual]

切断

Implemented in qrk::mConnection, qrk::SerialDevice, and qrk::TcpipSocket.

virtual void qrk::Connection::flush ( void   )  [pure virtual]

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

Implemented in qrk::mConnection, qrk::SerialDevice, and qrk::TcpipSocket.

virtual bool qrk::Connection::isConnected ( void   )  const [pure virtual]

接続状態を返す

Return values:
true 接続中
false 切断中

Implemented in qrk::mConnection, qrk::SerialDevice, and qrk::TcpipSocket.

virtual int qrk::Connection::receive ( char *  data,
size_t  count,
int  timeout 
) [pure virtual]

受信

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

Implemented in qrk::mConnection, qrk::SerialDevice, and qrk::TcpipSocket.

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

送信

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

Implemented in qrk::mConnection, qrk::SerialDevice, and qrk::TcpipSocket.

virtual bool qrk::Connection::setBaudrate ( long  baudrate  )  [pure virtual]

ボーレートの変更

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

Implemented in qrk::mConnection, qrk::SerialDevice, and qrk::TcpipSocket.

virtual size_t qrk::Connection::size ( void   )  const [pure virtual]

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

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

Implemented in qrk::mConnection, qrk::SerialDevice, and qrk::TcpipSocket.

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

1文字書き戻す

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

Implemented in qrk::mConnection, qrk::SerialDevice, and qrk::TcpipSocket.

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

内部状態を返す

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

Implemented in qrk::mConnection, qrk::SerialDevice, and qrk::TcpipSocket.


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:14 2013