cconfigoption.h

//==========================================================================
//  CCONFIGOPTION.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_CCONFIGOPTION_H
#define __OMNETPP_CCONFIGOPTION_H

#include <string>
#include "cownedobject.h"

namespace omnetpp {


class SIM_API cConfigOption : public cNoncopyableOwnedObject
{
  public:
    enum Type {
      CFG_BOOL,
      CFG_INT,
      CFG_DOUBLE,
      CFG_STRING,
      CFG_FILENAME,
      CFG_FILENAMES,
      CFG_PATH,
      CFG_CUSTOM
    };

    enum ObjectKind {
        KIND_NONE,
        KIND_COMPONENT,
        KIND_CHANNEL,
        KIND_MODULE,
        KIND_SIMPLE_MODULE,
        KIND_UNSPECIFIED_TYPE, // for 'typename' option (object is submodule/channel declared with 'like')
        KIND_PARAMETER,
        KIND_STATISTIC,
        KIND_SCALAR,
        KIND_VECTOR,
        KIND_OTHER
    };

    // note: option name (e.g. "sim-time-limit") is stored in object's name field
    bool isPerObject_;         // if true, entries must be in <object-full-path>.config-name format
    bool isGlobal_;            // if true, entries may only occur in the [General] section
    ObjectKind objectKind;     // kind of the object if isPerObject is true, KIND_NONE otherwise
    Type type;                 // option data type
    std::string unit;          // if numeric, its unit ("s") or empty string
    std::string defaultValue;  // the default value in string form
    std::string description;   // help text

  public:
    cConfigOption(const char *name, bool isGlobal, Type type, const char *unit,
               const char *defaultValue, const char *description);

    cConfigOption(const char *name, ObjectKind kind, Type type, const char *unit,
               const char *defaultValue, const char *description);

    virtual std::string str() const override;

    bool isPerObject() const {return isPerObject_;}

    bool isGlobal() const  {return isGlobal_;}

    ObjectKind getObjectKind() const {return objectKind;}

    static const char *getObjectKindName(ObjectKind kind);

    Type getType() const  {return type;}

    static const char *getTypeName(Type type);

    const char *getUnit() const  {return unit.empty() ? nullptr : unit.c_str();}

    const char *getDefaultValue() const  {return defaultValue.empty() ? nullptr : defaultValue.c_str();}

    const char *getDescription() const  {return description.c_str();}

    static cConfigOption *find(const char *name);

    static cConfigOption *get(const char *name);
};

}  // namespace omnetpp


#endif