BxDataObjects.h

// ##################################################################
// BinX
// $Id: BxDataObjects_8h-source.html,v 1.1.1.1 2006/04/19 14:19:02 edikt2 Exp $
//
// Simple list class to be used as an ordered collection to hold
// data objects.
// ##################################################################
/*

//  edikt::BinX
//  www.edikt.org
//  support@edikt.org

// Copyright (c) 2003 The University of Edinburgh.

*/

#ifndef __BxDataObjects__
#define __BxDataObjects__

#include "BxObject.h"
#include "BxDataObject.h"

/*
 * Collection class holding an ordered list of BxDataObject instances.
 * An instance of this class holds references to one or more objects.
 * The referenced objects must be instances of any class
 * derived from the class BXDataObject.
 * Hence, an instance of the class BxDataObjects holds references to objects of different types.
 * This class implements collection management methods to:
 * <ul>
 * <li>Add and remove object instances from the collection.</li>
 * <li>Locate an object in the collection
 * based on it relative location in the collection list or based on its value.</li>
 * </UL>
 * <BR><B>Implementation Notes:</B><BR>
 * Currently, a collection is initially constructed to hold
 * a small number of object references.
 * Objects references can be incrementally added to the collection.
 * When the number of objects would exceed the initial size of the collection,
 * the collection capacity is increased by a fixed amount.
 * <BR><B>Since:</B>  BinX version 1.0.
 */
class DECLSPEC BxDataObjects : public BxObject
{
private:
    BxDataObject ** elements_;   //<an array to hold references to the objects in this set
    int     capacity_;      //<number of elements the current array can hold
    int     elementCount_;  //<number of initialized elements in the array of objects
    int     incrementSize_;    //<number of physical elements slots to add each time the object set must be expanded

public:
    BxDataObjects();
    BxDataObjects(int,int);    //capacity and incrementSize
    virtual ~BxDataObjects();

    virtual char* className() const { return "BxDataObjects"; } //<Returns the null-terminated string "BxDataObjects".

    bool add(BxDataObject*);   //add a created data object at the end of the array
    BxDataObject * remove(int index);     //remove an element by index
    BxDataObject * remove(const char * typeName);
    void clear();   //remove all elements
    BxDataObject * get(int index) const;  //get the object pointer by index
    BxDataObject * operator[](int index) const;
    BxDataObject * searchByTypeName(const char * typeName);
    int count() const { return elementCount_; }    //return elementCount_, the number of elements in the list

protected:
    bool expand();
};

#endif

---