OpenRTM-aist  1.2.1
公開メンバ関数 | 限定公開メンバ関数 | 全メンバ一覧
RTC::NullBuffer< DataType > クラステンプレート

ダミーバッファ実装クラス [詳解]

#include <BufferBase.h>

RTC::NullBuffer< DataType > の継承関係図
Inheritance graph
[凡例]
RTC::NullBuffer< DataType > 連携図
Collaboration graph
[凡例]

公開メンバ関数

 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, bool unlock_enable=true)=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, bool unlock_enable=true)=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 リターンコードを文字列に変換 [詳解]
 

詳解

template<class DataType>
class RTC::NullBuffer< DataType >

ダミーバッファ実装クラス

バッファ長が１固定のダミーバッファ実装クラス。 <DataType>としてバッファ内で保持するデータ型を指定する。

引数
DataTypeバッファに格納するデータ型
から
0.4.0

構築子と解体子

template<class DataType >
RTC::NullBuffer< DataType >::NullBuffer ( long int  size = 1)
inline

コンストラクタ

コンストラクタ バッファ長を1(固定)で初期化する。

引数
sizeバッファ長(ただし無効)
template<class DataType >
virtual RTC::NullBuffer< DataType >::~NullBuffer ( void  )
inlinevirtual

デストラクタ

デストラクタ。

関数詳解

template<class DataType >
virtual const DataType& RTC::NullBuffer< DataType >::get ( void  )
inlineprotectedvirtual

バッファからデータを取得する

バッファに格納されたデータを取得する。

戻り値
取得データ

RTC::BufferBase< DataType >を実装しています。

template<class DataType >
virtual DataType& RTC::NullBuffer< DataType >::getRef ( void  )
inlineprotectedvirtual

次に書き込むバッファへの参照を取得する

書き込みバッファへの参照を取得する。 本バッファ実装ではバッファ長は固定で１であるため， 常に同じ位置への参照を返す。

戻り値
次の書き込み対象バッファへの参照(固定)
template<class DataType >
virtual bool RTC::NullBuffer< DataType >::isEmpty ( void  ) const
inlinevirtual

バッファemptyチェック

バッファemptyをチェックする。(常にfalseを返す。)

戻り値
emptyチェック結果(常にfalse)
template<class DataType >
virtual bool RTC::NullBuffer< DataType >::isFull ( void  ) const
inlinevirtual

バッファfullチェック

バッファfullをチェックする。(常にfalseを返す。)

戻り値
fullチェック結果(常にfalse)
template<class DataType >
virtual long int RTC::NullBuffer< DataType >::length ( void  ) const
inlinevirtual

バッファ長(1固定)を取得する

バッファ長を取得する。(常に1を返す。)

戻り値
バッファ長(1固定)

RTC::BufferBase< DataType >を実装しています。

template<class DataType >
virtual void RTC::NullBuffer< DataType >::put ( const DataType &  data)
inlineprotectedvirtual

バッファにデータを格納

引数で与えられたデータをバッファに格納する。

引数
data対象データ

RTC::BufferBase< DataType >を実装しています。

template<class DataType >
virtual bool RTC::NullBuffer< DataType >::read ( DataType &  value)
inlinevirtual

バッファからデータを読み出す

バッファに格納されたデータを読み出す。

引数
value読み出したデータ
戻り値
データ読み出し結果(true:読み出し成功，false:読み出し失敗)
template<class DataType >
virtual bool RTC::NullBuffer< DataType >::write ( const DataType &  value)
inlinevirtual

バッファにデータを書き込む

引数で与えられたデータをバッファに書き込む。

引数
value書き込み対象データ
戻り値
データ書き込み結果(true:書き込み成功，false:書き込み失敗)
このクラス詳解は次のファイルから抽出されました:
構築:   doxygen 1.8.11