csoftowner.h

//==========================================================================
//  CSOFTOWNER.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_CSOFTOWNER_H
#define __OMNETPP_CSOFTOWNER_H
 
#include "cownedobject.h"
 
namespace omnetpp {
 
 
class SIM_API cSoftOwner : public cNoncopyableOwnedObject
{
    friend class cObject;
    friend class cOwnedObject;
    friend class cChannelType;
 
  private:
    cOwnedObject **objs = nullptr; // array of owned objects
    int numObjs = 0;         // number of elements used in objects[] (0..num-1)
    int capacity = 0;        // allocated size of objs[]
 
#ifdef SIMFRONTEND_SUPPORT
  private:
    int64_t lastChangeSerial;
#endif
 
  private:
    void doInsert(cOwnedObject *obj);
    virtual void ownedObjectDeleted(cOwnedObject *obj) override;
    virtual void yieldOwnership(cOwnedObject *obj, cObject *newOwner) override;
  protected:
    void reportUndisposed();
    virtual void objectStealingOnDeletion(cOwnedObject *obj);
 
  public:
    // internal: constructor for the global cSoftOwner instance globalOwningContext which has no owner
    explicit cSoftOwner(const char *name, bool namepooling, internal::Void *dummy) : cNoncopyableOwnedObject(name, namepooling, dummy) {}
 
#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 cSoftOwner(const char *name=nullptr, bool namepooling=true);
 
    virtual ~cSoftOwner();
 
    virtual bool isSoftOwner() const override {return true;}
 
    virtual std::string str() const override;
 
    virtual void forEachChild(cVisitor *v) override;
 
    // Note: we need long method names here because cModule subclasses from this class
 
    int getNumOwnedObjects() const {return numObjs;}
 
    cOwnedObject *getOwnedObject(int k);
};
 
}  // namespace omnetpp
 
 
#endif