cnamedobject.h

//==========================================================================
//  CNAMEDOBJECT.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_CNAMEDOBJECT_H
#define __OMNETPP_CNAMEDOBJECT_H

#include <typeinfo>
#include <iostream>
#include "simkerneldefs.h"
#include "simutil.h"
#include "cobject.h"
#include "cexception.h"
#include "cstringpool.h"

namespace omnetpp {


class SIM_API cNamedObject : public cObject
{
  private:
    const char *name;  // object name (stringpooled if flags&FL_NAMEPOOLING!=0)

  protected:
    unsigned short flags;  // FL_NAMEPOOLING flag; other bits used by derived classes
    unsigned short unused; // space lost to due to word aligment; one may make use of it in subclasses (cModule, cSimpleModule, cGate)
    enum {FL_NAMEPOOLING = 1};

  private:
    void copy(const cNamedObject& other);

  protected:
    // internal: set a bit in flags; flag is one of the FL_xxx constants
    void setFlag(int flag, bool value) {if (value) flags|=flag; else flags&=~flag;}

  private:
    // pool for shared storage of object names
    static cStringPool stringPool;

  public:
    cNamedObject();

    explicit cNamedObject(const char *name, bool namepooling=true);

    cNamedObject(const cNamedObject& obj);

    virtual ~cNamedObject();

    cNamedObject& operator=(const cNamedObject& o);

    // Note: dup() is still the original cObject one, which throws an error
    // to indicate that dup() has to be redefined in each subclass.

    virtual void parsimPack(cCommBuffer *buffer) const override;

    virtual void parsimUnpack(cCommBuffer *buffer) override;

    virtual void setName(const char *s);

    virtual const char *getName() const override  {return name ? name : "";}

    virtual void setNamePooling(bool b);

    virtual bool getNamePooling() {return flags&FL_NAMEPOOLING;}
};

}  // namespace omnetpp


#endif