---

d_Collection.h

Go to the documentation of this file.

#ifndef d_Collection_h
#define d_Collection_h 1
//------------------------------------------------------------------------------

#include "oDynaObject.h"
#include "d_Ref.h"
#include "d_Object.h"

//------------------------------------------------------------------------------
template <class T> class _ODLL oCollBlock;
template< class T > class _ODLL d_Iterator;
class _ODLL d_Database;
//------------------------------------------------------------------------------

/**
 * This is the base-abstract class for all collection classes.
 *
 * Thus you can't use this class directly, but use real container classes.
 *
 * SEE ALSO:
 * d_Bag, d_Dictionary, d_Iterator, d_List, d_Set, d_Varray
 *
 * ODMG:
 * Compliant
 */

template <class T>
class _ODLL d_Collection : public d_Object
{
  public:
    /**
     * Default constructor.
     *
     * <iBlockSize> is the optional preallocated size (default is
     * 64 elements).
     *
     * ODMG    :  Compliant
     */
    d_Collection (oUInt2 iBlockSize = dBlockSize);

    /**
     * Destructor.
     *
     * ODMG    :  Compliant
     */
    virtual ~d_Collection();

    virtual void d_deactivate();

    /**
     * Insert an element.
     *
     * ODMG    :  Compliant
     */
    void insert_element (const T& iElem);

    /**
     * Returns an iterator that points to the first element.
     *
     * SEE ALSO:  begin()
     * ODMG    :  Compliant
     */
    d_Iterator<T> create_iterator () const;

    /**
     * Returns an iterator that points to the first element.
     *
     * Permits to handle the container by STL classes.
     *
     * SEE ALSO:  create_iterator()
     * ODMG    :  Compliant
     */
    d_Iterator<T> begin () const;

    /**
     * Returns an iterator that points to the last element.
     *
     * Permits to handle the container by STL classes.
     *
     * SEE ALSO:  begin()
     * ODMG    :  Compliant
     */
    d_Iterator<T> end () const;

    /**
     * Remove all the elements in the collection.
     *
     * ODMG    :  Compliant
     */
    void remove_all ();

    /**
     * Returns the number of elements in the collection.
     *
     * ODMG    :  Compliant
     */
    d_ULong cardinality () const;

    virtual d_Boolean allows_duplicates () const = 0;
    virtual d_Boolean is_ordered () const = 0;

    /**
     * Returns true if the collection doesn't contain elements, otherwise
     * true.
     *
     * ODMG    :  Compliant 
     */
    d_Boolean is_empty () const;

    // Internal.
    oUInt2 blockSize;
    // Internal.
    d_Ref<oCollBlock<T> > head;
    // Internal.
    d_Ref<oCollBlock<T> > tail;

  protected:
    // Internal.
    oUInt2 blocks;
    // Internal.
    oUInt4 total;
    // Internal.
    oDynaObject* dynaObject;

  private:
    // Internal.
    static oUInt2 dBlockSize;
};

//------------------------------------------------------------------------------
template <class T>
inline d_ULong d_Collection<T>::cardinality () const
{
  return total;
}

//------------------------------------------------------------------------------
#include "d_Collection.cti"

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

#endif

---