g++ [flags ...] file ...

#include <CircularBuffer.h>
CircularBuffer(long capacity = DEF_BUF_CAPACITY);
boolean append(const TObject in);  
boolean append(const Vector>TObject<& in);
boolean seekCurr(long offset);
boolean setRead(long num_read = DEF_NUM_READ);

// declare a Float CircularBuffer of capacity 5
//
CircularBuffer<Float> cbuf(5);

for (long i = 0; i < 5; i++) {
  Float num((float)i);
  cbuf.append(num);
}

// check the number of elements and if the buffer is full
//
if (cbuf.getNumElements() != 5 || !cbuf.isFull()) {
     // error
  }
}

• none.

• none

• This example shows how to construct a CircularBuffer and check its status:

  #include <Long.h>
  #include <CircularBuffer.h>
  
  int main () {
  
    // declare a circular buffer of long
    //
    CircularBuffer<Long> cbuf(50);
  
    // prepare data  
    //
    Vector<Long> longs(100);
    for (long i = 0; i <100; i++) {
      longs(i) = i;
    }
    
    // add the data to the buffer
    //
    cbuf.append(longs, 50, 0);               // [0 - 50] were appended
  
    // the buffer should be full now
    //
    if (!cbuf.isFull()) {
      
      // exit
      //
      Integral::exit();
    }
  
    // release some data in buffer and append more data
    //
    cbuf.setRead(40);
  
    cbuf.append(longs, 10, 50);               // [0 - 9] were overwritten
    
    // display the contents of the circular buffer
    //
    cbuf.debug(L"cbuf");
    
    // exit gracefully
    //
    Integral::exit();
  }

• There is no memory allocation mode for the CircularBuffer class. CircularBuffer always operates in SYSTEM mode. The objects contained within a CircularBuffer can use either allocation mode by invoking their setAllocationMode method.
  
  
• Unlike other classes, we have two read and write methods in dstr classes. The interface is still the same as that in other classes. The reason behind this is that we cannot use "CLASS_NAME" as a default argument in the read and write methods here because the data structures build the class name on the fly.