BufferBase.h

Go to the documentation of this file.

// -*- C++ -*-
/*
 * $Log: BufferBase.h,v $
 * Revision 1.2.4.2  2007/09/21 09:18:12  n-ando
 * Documentation was modified.
 *
 * Revision 1.2  2006/12/02 18:24:15  n-ando
 * BufferBase's interfaces were changed.
 *
 * Revision 1.1  2006/11/27 09:44:34  n-ando
 * The first commitment.
 *
 */

#ifndef BufferBase_h
#define BufferBase_h

namespace RTC
{
  template <class DataType>
  class BufferBase
  {
  public:
    virtual ~BufferBase(){};

    virtual long int length() const = 0;

    virtual bool write(const DataType& value) = 0;

    virtual bool read(DataType& value) = 0;

    virtual bool isFull() const = 0;

    virtual bool isEmpty() const = 0;

  protected:
    virtual void put(const DataType& data) = 0;

    virtual const DataType& get() = 0;

    virtual DataType& getRef() = 0;

  };




  template <class DataType>
  class NullBuffer
    : public BufferBase<DataType>
  {
  public:
    NullBuffer(long int size = 1)
      : m_length(1)
    {
    }

    virtual ~NullBuffer()
    {
    }

    virtual long int length() const
    {
      return 1;
    }

    virtual bool write(const DataType& value)
    {
      m_data = value;
      return true;
    }

    virtual bool read(DataType& value)
    {
      value = m_data;
      return true;
    }

    virtual bool isFull() const
    {
      return false;
    }

    virtual bool isEmpty() const
    {
      return false;
    }
    
  protected:
    virtual void put(const DataType& data)
    {
      m_data = data;
    }

    virtual const DataType& get()
    {
      return m_data;
    }

    virtual DataType& getRef()
    {
      return m_data;
    }

  private:
    DataType m_data;
    long int m_length;
  };


}; // namespace RTC
#endif // BufferBase_h

---