# DoubleBuffer3D (Colt 1.2.0 - API Specification)
Date: 2013-07-23

Colt 1.2.0

## cern.colt.buffer
Class DoubleBuffer3D

    java.lang.Object
      cern.colt.PersistentObject
          cern.colt.buffer.DoubleBuffer3D

All Implemented Interfaces:
  DoubleBuffer3DConsumer, java.io.Serializable, java.lang.Cloneable

    public class DoubleBuffer3D

extends PersistentObject
implements DoubleBuffer3DConsumer

Fixed sized (non resizable) streaming buffer connected to a target `DoubleBuffer3DConsumer` to which data is automatically flushed upon buffer overflow.

Version:
  1.0, 09/24/99
See Also:
  Serialized Form

Field Summary

Fields inherited from class cern.colt.PersistentObject
`serialVersionUID`

Constructor Summary
`DoubleBuffer3D(DoubleBuffer3DConsumer target, int capacity)` Constructs and returns a new buffer with the given target.

Method Summary
`void` `add(double x, double y, double z)` Adds the specified point (x,y,z) to the receiver.
`void` `addAllOf(DoubleArrayList xElements, DoubleArrayList yElements, DoubleArrayList zElements)` Adds all specified (x,y,z) points to the receiver.
`void` `clear()` Sets the receiver's size to zero.
`void` `flush()` Adds all internally buffered points to the receiver's target, then resets the current buffer size to zero.

Methods inherited from class cern.colt.PersistentObject
`clone`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### DoubleBuffer3D

    public DoubleBuffer3D(DoubleBuffer3DConsumer target,
                          int capacity)

  Constructs and returns a new buffer with the given target.

  Parameters:
    `target` - the target to flush to.
    `capacity` - the number of points the buffer shall be capable of holding before overflowing and flushing to the target.

Method Detail

### add

    public void add(double x,
                    double y,
                    double z)

  Adds the specified point (x,y,z) to the receiver.

  Parameters:
    `x` - the x-coordinate of the point to add.
    `y` - the y-coordinate of the point to add.
    `z` - the z-coordinate of the point to add.

### addAllOf

    public void addAllOf(DoubleArrayList xElements,
                         DoubleArrayList yElements,
                         DoubleArrayList zElements)

  Adds all specified (x,y,z) points to the receiver.

  Specified by:
    `addAllOf` in interface `DoubleBuffer3DConsumer`
  Parameters:
    `xElements` - the x-coordinates of the points.
    `yElements` - the y-coordinates of the points.
    `zElements` - the y-coordinates of the points.

### clear

    public void clear()

  Sets the receiver's size to zero. In other words, forgets about any internally buffered elements.

### flush

    public void flush()

  Adds all internally buffered points to the receiver's target, then resets the current buffer size to zero.

Colt 1.2.0

Jump to the Colt Homepage