cproperties.h

//==========================================================================
//  CPROPERTIES.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_CPROPERTIES_H
#define __OMNETPP_CPROPERTIES_H

#include <vector>
#include "simkerneldefs.h"
#include "globals.h"
#include "cobject.h"

namespace omnetpp {

class cProperty;


class SIM_API cProperties : public cObject
{
  protected:
    bool isLocked;
    int refCount;
    std::vector<cProperty *> properties;

  private:
    void copy(const cProperties& other);

  public:
    // internal: locks the object and all contained properties against modifications.
    // The object cannot be unlocked -- one must copy contents to an unlocked
    // object, or call dup() (new objects are created in unlocked state).
    virtual void lock();

    // internal: increment/decrement reference count
    int addRef()  {return ++refCount;}
    int removeRef()  {return --refCount;}

  public:
    explicit cProperties();

    cProperties(const cProperties& other) : cObject(other) {refCount=0; isLocked=false; copy(other);}

    virtual ~cProperties();

    cProperties& operator=(const cProperties& other);

    virtual cProperties *dup() const override  {return new cProperties(*this);}

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

    virtual std::string str() const override;

    virtual void parsimPack(cCommBuffer *buffer) const override;

    virtual void parsimUnpack(cCommBuffer *buffer) override;

    virtual int getNumProperties() const  {return properties.size();}

    virtual const std::vector<const char *> getNames() const;

    virtual cProperty *get(int k) const;

    virtual cProperty *get(const char *name, const char *index=nullptr) const;

    virtual bool getAsBool(const char *name, const char *index=nullptr) const;

    virtual std::vector<const char *> getIndicesFor(const char *name) const;

    virtual void add(cProperty *p);

    virtual void remove(int k);
};

}  // namespace omnetpp


#endif