cobject.h

//==========================================================================
//  COBJECT.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_COBJECT_H
#define __OMNETPP_COBJECT_H

#include <string>
#include "simkerneldefs.h"
#include "simutil.h"
#include "cvisitor.h"

// Note: we include regmacros.h here in order to prevent the compiler from
// misunderstanding Register_Class() in other source files as a function declaration
#include "regmacros.h"

namespace omnetpp {

class cCommBuffer;
class cClassDescriptor;
class cOwnedObject;


class SIM_API cObject
{
    friend class cOwnedObject;
    friend class cDefaultList;

  public:
    // internal: returns a descriptor object for this object
    virtual cClassDescriptor *getDescriptor() const;

#ifdef SIMFRONTEND_SUPPORT
    // internal: used by the UI to optimize refreshes
    virtual bool hasChangedSince(int64_t refreshSerial);
    static int64_t getChangeCounter() {return changeCounter;}
#endif

  protected:
#ifdef SIMFRONTEND_SUPPORT
    // internal
    static int64_t changeCounter;
#endif

    // internal
    virtual void ownedObjectDeleted(cOwnedObject *obj);

    // internal
    virtual void yieldOwnership(cOwnedObject *obj, cObject *to);

  public:
    cObject() {}

    cObject(const cObject& other) {}

    virtual ~cObject();

    virtual const char *getClassName() const;

    virtual const char *getName() const  {return "";}

    bool isName(const char *s) const {return !opp_strcmp(getName(),s);}

    virtual const char *getFullName() const  {return getName();}

    virtual std::string getFullPath() const;

    const cObject *getThisPtr() const  {return this;}  //Note: nonvirtual

    virtual std::string str() const;

    _OPPDEPRECATED virtual std::string info() const {return str();}

    _OPPDEPRECATED virtual std::string detailedInfo() const {return "";}

    virtual cObject *dup() const;

  protected:

    virtual void take(cOwnedObject *obj);

    virtual void drop(cOwnedObject *obj);

    void dropAndDelete(cOwnedObject *obj);

  public:
    virtual void parsimPack(cCommBuffer *buffer) const;

    virtual void parsimUnpack(cCommBuffer *buffer);

    virtual cObject *getOwner() const {return nullptr;}

    virtual bool isOwnedObject() const {return false;}

    virtual void forEachChild(cVisitor *v);

    cObject *findObject(const char *name, bool deep=true);

    void copyNotSupported() const;
};


class noncopyable
{
  protected:
    noncopyable() {}
    ~noncopyable() {}
  private:
    // private, and in addition unimplemented (usage causes missing linker symbol)
    noncopyable(const noncopyable& x);
    const noncopyable& operator=(const noncopyable&);
};

}  // namespace omnetpp


#endif