|
OpenRTM-aist
1.1.2
|
ダミーバッファ実装クラス [詳解]
#include <BufferBase.h>
公開メンバ関数 | |
| NullBuffer (long int size=1) | |
| コンストラクタ [詳解] | |
| virtual | ~NullBuffer (void) |
| デストラクタ [詳解] | |
| virtual long int | length (void) const |
| バッファ長(1固定)を取得する [詳解] | |
| virtual bool | write (const DataType &value) |
| バッファにデータを書き込む [詳解] | |
| virtual bool | read (DataType &value) |
| バッファからデータを読み出す [詳解] | |
| virtual bool | isFull (void) const |
| バッファfullチェック [詳解] | |
| virtual bool | isEmpty (void) const |
| バッファemptyチェック [詳解] | |
基底クラス RTC::BufferBase< DataType > に属する継承公開メンバ関数 | |
| virtual BUFFERSTATUS_ENUM | ~BufferBase (void) |
| 仮想デストラクタ [詳解] | |
| virtual void | init (const coil::Properties &prop)=0 |
| バッファの設定 [詳解] | |
| virtual ReturnCode | length (size_t n)=0 |
| バッファの長さをセットする [詳解] | |
| virtual ReturnCode | reset ()=0 |
| バッファの状態をリセットする [詳解] | |
| virtual DataType * | wptr (long int n=0)=0 |
| バッファの現在の書込み要素のポインタ [詳解] | |
| virtual ReturnCode | advanceWptr (long int n=1)=0 |
| 書込みポインタを進める [詳解] | |
| virtual ReturnCode | write (const DataType &value, long int sec=-1, long int nsec=-1)=0 |
| バッファにデータを書き込む [詳解] | |
| virtual size_t | writable () const =0 |
| バッファに書込み可能な要素数 [詳解] | |
| virtual bool | full (void) const =0 |
| バッファfullチェック [詳解] | |
| virtual DataType * | rptr (long int n=0)=0 |
| バッファの現在の読み出し要素のポインタ [詳解] | |
| virtual ReturnCode | advanceRptr (long int n=1)=0 |
| 読み出しポインタを進める [詳解] | |
| virtual ReturnCode | get (DataType &value)=0 |
| バッファからデータを読み出す [詳解] | |
| virtual ReturnCode | read (DataType &value, long int sec=-1, long int nsec=-1)=0 |
| バッファからデータを読み出す [詳解] | |
| virtual size_t | readable () const =0 |
| バッファから読み出し可能な要素数 [詳解] | |
| virtual bool | empty (void) const =0 |
| バッファemptyチェック [詳解] | |
限定公開メンバ関数 | |
| virtual void | put (const DataType &data) |
| バッファにデータを格納 [詳解] | |
| virtual const DataType & | get (void) |
| バッファからデータを取得する [詳解] | |
| virtual DataType & | getRef (void) |
| 次に書き込むバッファへの参照を取得する [詳解] | |
その他の継承メンバ | |
基底クラス RTC::BufferStatus に属する継承公開型 | |
| enum | Enum { BUFFER_OK = 0, BUFFER_ERROR, BUFFER_FULL, BUFFER_EMPTY, NOT_SUPPORTED, TIMEOUT, PRECONDITION_NOT_MET } |
| BufferStatus リターンコード [詳解] | |
基底クラス RTC::BufferStatus に属する継承静的公開メンバ関数 | |
| static const char * | toString (Enum status) |
| BufferStatus リターンコードを文字列に変換 [詳解] | |
ダミーバッファ実装クラス
バッファ長が1固定のダミーバッファ実装クラス。 <DataType>としてバッファ内で保持するデータ型を指定する。
| DataType | バッファに格納するデータ型 |
|
inline |
コンストラクタ
コンストラクタ バッファ長を1(固定)で初期化する。
| size | バッファ長(ただし無効) |
|
inlinevirtual |
デストラクタ
デストラクタ。
|
inlineprotectedvirtual |
|
inlineprotectedvirtual |
次に書き込むバッファへの参照を取得する
書き込みバッファへの参照を取得する。 本バッファ実装ではバッファ長は固定で1であるため, 常に同じ位置への参照を返す。
|
inlinevirtual |
バッファemptyチェック
バッファemptyをチェックする。(常にfalseを返す。)
|
inlinevirtual |
バッファfullチェック
バッファfullをチェックする。(常にfalseを返す。)
|
inlinevirtual |
|
inlineprotectedvirtual |
|
inlinevirtual |
バッファからデータを読み出す
バッファに格納されたデータを読み出す。
| value | 読み出したデータ |
|
inlinevirtual |
バッファにデータを書き込む
引数で与えられたデータをバッファに書き込む。
| value | 書き込み対象データ |
1.8.11