cdefaultlist.h

//==========================================================================
//  CDEFAULTLIST.H - part of
//
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//
//  Declaration of the following classes:
//    cDefaultList : holds a set of cOwnedObjects
//
//==========================================================================

/*--------------------------------------------------------------*
  Copyright (C) 1992-2008 Andras Varga
  Copyright (C) 2006-2008 OpenSim Ltd.

  This file is distributed WITHOUT ANY WARRANTY. See the file
  `license' for details on this and other legal matters.
*--------------------------------------------------------------*/

#ifndef __CDEFAULTLIST_H
#define __CDEFAULTLIST_H

#include "cownedobject.h"

NAMESPACE_BEGIN


class SIM_API cDefaultList : public cNoncopyableOwnedObject
{
    friend class cObject;
    friend class cOwnedObject;
    friend class cChannelType;

  private:
    enum {FL_PERFORMFINALGC = 2};  // whether to delete owned objects in the destructor

  private:
    cOwnedObject **vect; // vector of objects
    int capacity;        // allocated size of vect[]
    int size;            // number of elements used in vect[] (0..size-1)

  private:
    void construct();
    void doInsert(cOwnedObject *obj);
    virtual void ownedObjectDeleted(cOwnedObject *obj);
    virtual void yieldOwnership(cOwnedObject *obj, cObject *newOwner);

  public:
    // internal: called from module creation code in ctypes.cc
    void takeAllObjectsFrom(cDefaultList& other);

  protected:

    void take(cOwnedObject *obj);

    void drop(cOwnedObject *obj);

  public:
    explicit cDefaultList(const char *name=NULL);

    virtual ~cDefaultList();

    virtual bool isSoftOwner() const {return true;}

    virtual std::string info() const;

    virtual void forEachChild(cVisitor *v);

    virtual void parsimPack(cCommBuffer *buffer);

    virtual void parsimUnpack(cCommBuffer *buffer);

    // Note: we need long method names here because cModule subclasses from this class

    bool getPerformFinalGC() const  {return flags&FL_PERFORMFINALGC;}

    virtual void setPerformFinalGC(bool b)  {setFlag(FL_PERFORMFINALGC,b);}

    int defaultListSize() const {return size;}

    cOwnedObject *defaultListGet(int k);

    // Note: we need a long name here because cModule subclasses from this
    bool defaultListContains(cOwnedObject *obj) const;
};

NAMESPACE_END


#endif