趣味で作ってるロボット用ソフトウェア
 All Classes Files Functions Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
hrk::Log_recorder Class Reference
Inheritance diagram for hrk::Log_recorder:
Inheritance graph
[legend]
Collaboration diagram for hrk::Log_recorder:
Collaboration graph
[legend]

Public Types

enum  role_t { Play, Record }
 
- Public Types inherited from hrk::Connection
enum  { Timeout_infinity = -1 }
 

Public Member Functions

bool open (Connection *connection, const std::string &base_name, const role_t role=Record)
 扱う connection を登録する More...
 
const char * what () const
 状態を示すメッセージを返す More...
 
bool change_baudrate (long baudrate)
 ボーレートの変更 More...
 
bool is_open () const
 受信 More...
 
void close ()
 接続を閉じる More...
 
int write (const char *data, size_t data_size)
 データの送信 More...
 
int read (char *data, size_t max_data_size, int timeout)
 データの受信 More...
 
void ungetc (int ch)
 1文字だけ受信バッファに書き戻す
 

Member Function Documentation

bool Log_recorder::open ( Connection connection,
const std::string &  base_name,
const role_t  role = Record 
)

扱う connection を登録する

Parameters
[in]connection記録対象
[in]base_nameログファイルのベース名
[in]role保存か読み込みかの設定
Return values
true成功
false失敗
const char * Log_recorder::what ( ) const
virtual

状態を示すメッセージを返す

Returns
メッセージ文字列

Implements hrk::Connection.

bool Log_recorder::change_baudrate ( long  baudrate)
virtual

ボーレートの変更

Parameters
[in]baudrateボーレート [bps]
Return values
true成功
falseエラー

Implements hrk::Connection.

bool Log_recorder::is_open ( ) const
virtual

受信

Return values
true接続中
false接続していない

Implements hrk::Stream.

void Log_recorder::close ( )
virtual

接続を閉じる

接続されてないときに呼び出されたときは、何もしない。

Implements hrk::Stream.

int Log_recorder::write ( const char *  data,
size_t  data_size 
)
virtual

データの送信

Parameters
[in]data送信するデータ
[in]data_size送信するデータの byte 数
Return values
>=0送信した byte 数
<0エラー ID

Implements hrk::Stream.

int Log_recorder::read ( char *  data,
size_t  max_data_size,
int  timeout 
)
virtual

データの受信

Parameters
[in]data受信データ用のバッファ
[in]max_data_size受信できるデータの最大 byte 数
[in]timeout受信を待つ時間 [msec]。無限に待つ場合には Timeout_infinity を指定する。
Return values
>=0送信した byte 数
<0エラー ID

Implements hrk::Stream.


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