クラス RTC::BufferStatus

BufferStatus mixin クラス. [詳細]

#include <BufferStatus.h>

RTC::BufferStatusに対する継承グラフ
RTC::BufferBase< DataType > RTC::NullBuffer< DataType > RTC::RingBuffer< DataType >

すべてのメンバ一覧

Public 型

enum  Enum {
  BUFFER_OK = 0, BUFFER_ERROR, BUFFER_FULL, BUFFER_EMPTY,
  NOT_SUPPORTED, TIMEOUT, PRECONDITION_NOT_MET
}
 

BufferStatus リターンコード.

[詳細]

Static Public メソッド

static const char * toString (Enum status)
 BufferStatus リターンコードを文字列に変換.

説明

BufferStatus mixin クラス.

このクラスは、enum定義されたリターンコードを、バッファ関連サブクラ スで共通利用するための mixin クラスである。このリターンコードを使 用するクラスでは、BufferStatus クラスをpublic 継承し、下に define してある BUFFERSTATUS_ENUM をクラス内に記述することで利用可能とな る。これにより、enum を ReturnCode_t 型として typedef し、以後 ReturnCode_t を利用できるようにするとともに、名前空間に enum 定義 された各識別子を当該クラス名前空間内に導入する。


列挙型

BufferStatus リターンコード.

バッファ関連のクラスで共通のリターンコード

  • BUFFER_OK: 正常終了
  • BUFFER_ERROR: バッファエラー
  • BUFFER_FULL: バッファフル
  • BUFFER_EMPTY: バッファエンプティ
  • NOT_SUPPORTED: 未サポート機能
  • TIMEOUT: タイムアウト
  • PRECONDITION_NOT_MET: 事前条件を満たしていない
列挙型の値:
BUFFER_OK 
BUFFER_ERROR 
BUFFER_FULL 
BUFFER_EMPTY 
NOT_SUPPORTED 
TIMEOUT 
PRECONDITION_NOT_MET 

関数

static const char* RTC::BufferStatus::toString ( Enum  status  )  [inline, static]

BufferStatus リターンコードを文字列に変換.

BufferStatus リターンコードを文字列に変換する

引数:
status 変換対象 BufferStatus リターンコード
戻り値:
文字列変換結果
OpenRTMに対してFri Mar 11 00:00:50 2011に生成されました。  doxygen 1.6.3