cdefaultlist.h

//==========================================================================
//  CDEFAULTLIST.H - part of
//                     OMNeT++/OMNEST
//            Discrete System Simulation in C++
//
//==========================================================================

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

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

#ifndef __OMNETPP_CDEFAULTLIST_H
#define __OMNETPP_CDEFAULTLIST_H

#include "cownedobject.h"

namespace omnetpp {


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 **objs; // array of owned objects
    int numObjs;         // number of elements used in objects[] (0..num-1)
    int capacity;        // allocated size of objs[]

#ifdef SIMFRONTEND_SUPPORT
  private:
    int64_t lastChangeSerial;
#endif

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

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

#ifdef SIMFRONTEND_SUPPORT
    // internal: used by the UI to optimize refreshes
    void updateLastChangeSerial()  {lastChangeSerial = changeCounter++;}
    virtual bool hasChangedSince(int64_t lastRefreshSerial);
#endif

  protected:

    virtual void take(cOwnedObject *obj) override;

    virtual void drop(cOwnedObject *obj) override;

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

    virtual ~cDefaultList();

    virtual bool isSoftOwner() const override {return true;}

    virtual std::string str() const override;

    virtual void forEachChild(cVisitor *v) override;

    virtual void parsimPack(cCommBuffer *buffer) const override;

    virtual void parsimUnpack(cCommBuffer *buffer) override;

    // 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 numObjs;}

    cOwnedObject *defaultListGet(int k);

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

}  // namespace omnetpp


#endif