ダミーバッファ実装クラス [詳解]
#include <BufferBase.h>
RTC::NullBuffer< DataType > の継承関係図
RTC::NullBuffer< DataType > 連携図
公開メンバ関数 | |
| NullBuffer (long int size=1) | |
| コンストラクタ | |
| virtual | ~NullBuffer ()=default |
| デストラクタ | |
| virtual long int | length () const |
| バッファ長(1固定)を取得する | |
| virtual bool | write (const DataType &value) |
| バッファにデータを書き込む | |
| virtual bool | read (DataType &value) |
| バッファからデータを読み出す | |
| virtual bool | isFull () const |
| バッファfullチェック | |
| virtual bool | isEmpty () const |
| バッファemptyチェック | |
 基底クラス RTC::BufferBase< DataType > に属する継承公開メンバ関数 | |
| virtual | ~BufferBase ()=default |
| 仮想デストラクタ | |
| virtual void | init (const coil::Properties &prop)=0 |
| バッファの設定 | |
| virtual BufferStatus | length (size_t n)=0 |
| バッファの長さをセットする | |
| virtual BufferStatus | reset ()=0 |
| バッファの状態をリセットする | |
| virtual DataType * | wptr (long int n=0)=0 |
| バッファの現在の書込み要素のポインタ | |
| virtual BufferStatus | advanceWptr (long int n=1, bool unlock_enable=true)=0 |
| 書込みポインタを進める | |
| virtual BufferStatus | write (const DataType &value, std::chrono::nanoseconds timeout=std::chrono::nanoseconds(-1))=0 |
| バッファにデータを書き込む | |
| virtual size_t | writable () const =0 |
| バッファに書込み可能な要素数 | |
| virtual bool | full () const =0 |
| バッファfullチェック | |
| virtual DataType * | rptr (long int n=0)=0 |
| バッファの現在の読み出し要素のポインタ | |
| virtual BufferStatus | advanceRptr (long int n=1, bool unlock_enable=true)=0 |
| 読み出しポインタを進める | |
| virtual BufferStatus | get (DataType &value)=0 |
| バッファからデータを読み出す | |
| virtual BufferStatus | read (DataType &value, std::chrono::nanoseconds nsec=std::chrono::nanoseconds(-1))=0 |
| バッファからデータを読み出す | |
| virtual size_t | readable () const =0 |
| バッファから読み出し可能な要素数 | |
| virtual bool | empty () const =0 |
| バッファemptyチェック | |
限定公開メンバ関数 | |
| virtual void | put (const DataType &data) |
| バッファにデータを格納 | |
| virtual const DataType & | get () |
| バッファからデータを取得する | |
| virtual DataType & | getRef () |
| 次に書き込むバッファへの参照を取得する | |
詳解
template<class DataType>
class RTC::NullBuffer< DataType >
class RTC::NullBuffer< DataType >
ダミーバッファ実装クラス
バッファ長が１固定のダミーバッファ実装クラス。 <DataType>としてバッファ内で保持するデータ型を指定する。
- 引数
-
DataType バッファに格納するデータ型
- から
- 0.4.0
構築子と解体子
◆ NullBuffer()
template<class DataType >
|
inlineexplicit |
コンストラクタ
コンストラクタ バッファ長を1(固定)で初期化する。
- 引数
-
size バッファ長(ただし無効)
◆ ~NullBuffer()
template<class DataType >
|
virtualdefault |
デストラクタ
デストラクタ。
関数詳解
◆ get()
template<class DataType >
|
inlineprotectedvirtual |
◆ getRef()
template<class DataType >
|
inlineprotectedvirtual |
次に書き込むバッファへの参照を取得する
書き込みバッファへの参照を取得する。 本バッファ実装ではバッファ長は固定で１であるため， 常に同じ位置への参照を返す。
- 戻り値
- 次の書き込み対象バッファへの参照(固定)
◆ isEmpty()
template<class DataType >
|
inlinevirtual |
バッファemptyチェック
バッファemptyをチェックする。(常にfalseを返す。)
- 戻り値
- emptyチェック結果(常にfalse)
◆ isFull()
template<class DataType >
|
inlinevirtual |
バッファfullチェック
バッファfullをチェックする。(常にfalseを返す。)
- 戻り値
- fullチェック結果(常にfalse)
◆ length()
template<class DataType >
|
inlinevirtual |
◆ put()
template<class DataType >
|
inlineprotectedvirtual |
◆ read()
template<class DataType >
|
inlinevirtual |
バッファからデータを読み出す
バッファに格納されたデータを読み出す。
- 引数
-
value 読み出したデータ
- 戻り値
- データ読み出し結果(true:読み出し成功，false:読み出し失敗)
◆ write()
template<class DataType >
|
inlinevirtual |
バッファにデータを書き込む
引数で与えられたデータをバッファに書き込む。
- 引数
-
value 書き込み対象データ
- 戻り値
- データ書き込み結果(true:書き込み成功，false:書き込み失敗)
このクラス詳解は次のファイルから抽出されました:
構築:
1.11.0