---

d_Varray.h

Go to the documentation of this file.

#ifndef d_Varray_h
#define d_Varray_h 1

//------------------------------------------------------------------------------
#include "d_Collection.h"

/**
 * It's a container class (see Containers), it's ordered by index and allows
 * duplicates.
 *
 * This class is like the vector of the C++ Library, but is persistent.
 *
 * LOCATION:
 * d_Varray.h
 *
 * USAGE:
 * d_Varray< <type-name> >              <property-name>;
 * 
 * Where:
 * 
 * <type-name>:         Type to contain. Can be a literal or a user type
 * <PROPERTY-NAME>:     NAME OF PROPERTY
 *
 * EXAMPLES:
 * class Invoice : public d_Object
 * {
 *    * Relationship 1-n to product objects
 *   d_Varray< d_Ref<Product> > products;       
 * };
 * 
 * d_Ref<Invoice>                       myInvoice;               * Ref to Invoice object
 *
 * SEE ALSO:
 * d_Bag, d_Collection, d_Dictionary, d_Iterator, d_List, d_Set
 *
 * ODMG:
 * Compliant
 */

template <class T>
class _ODLL d_Varray : public d_Collection<T>
{
  public:
    /**
     * Default constructor.
     *
     * ODMG    :  Compliant 
     */
    d_Varray();

    /**
     * Returns the value at any position.
     *
     * Returns the value at position <iPosition>. If <iPosition> is out of the
     * range, an exception d_Error_PositionOutOfRange is raised.
     *
     * This method permits to handle a d_Varray object as a common C++ array.
     *
     * SEE ALSO:  retrieve_element_at()
     * ODMG    :  Compliant 
     */
    T operator [] (const oUInt4 iIndex);

    /**
     * Returns always true.
     *
     * ODMG    :  Compliant 
     */
    virtual d_Boolean allows_duplicates () const;

    /**
     * Returns always true.
     *
     * ODMG    :  Compliant 
     */
    virtual d_Boolean is_ordered () const;

    /**
     * Search the value in the container. 
     *
     * Search the value <iValue> in the array. If the element is found its
     * position is returned in <oPosition> and the method returns true;
     * otherwise it returns false.
     *
     * ODMG    :  Compliant 
     */
    d_Boolean find_element (const T& iValue, d_ULong& ioPosition);

    /**
     * Returns the value at any position.
     *
     * Returns the value at position <iPosition>. If <iPosition> is out of the
     * range, an exception d_Error_PositionOutOfRange is raised.
     *
     * SEE ALSO:  operator[]()
     * ODMG    :  Compliant 
     */
    T retrieve_element_at (const d_ULong iIndex);

    /**
     * Remove an element.
     *
     * Remove the element at position <iPosition>. If <iPosition> is out of the
     * range, an exception d_Error_PositionOutOfRange is raised.
     *
     * SEE ALSO:  remove_all(), d_Iterator::remove_element ()
     * ODMG    :  Compliant 
     */
    void remove_element_at (const d_ULong iPosition);

    /**
     * Replace an element.
     *
     * Replace the element at position <iPosition> with <iValue>. If
     * <iPosition> is out of the range, an exception d_Error_PositionOutOfRange
     * is raised.
     *
     * SEE ALSO:  d_Iterator::replace_element ()
     * ODMG    :  Compliant 
     */
    void replace_element_at (const T& iValue, const d_ULong iPosition);

    // INTERNAL CONSTRUCTOR
    d_Varray( d_Object::DynaFactoryConstructor* iObj ){;}

  private:
    // Internal.
    oCollBlock<T>* getBlockOfElement (const d_ULong iIndex, d_ULong& oPosInBlock);
};

//------------------------------------------------------------------------------
#include "d_Varray.cti"

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

#endif

---