cexpression.h

//==========================================================================
//   CEXPRESSION.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_CEXPRESSION_H
#define __OMNETPP_CEXPRESSION_H

#include "cobject.h"
#include "cexception.h"
#include "cnedvalue.h"

namespace omnetpp {

class cXMLElement;

class SIM_API cExpression : public cObject
{
  public:
    class SIM_API Context : public cObject
    {
      public:
        explicit Context(cComponent *component) : component(component) {}
        cComponent *component = nullptr;
    };

  public:

    explicit cExpression() {}

    cExpression(const cExpression& other) : cObject(other) {}

    virtual ~cExpression() {}

    cExpression& operator=(const cExpression& other) {return *this;}

    virtual cExpression *dup() const override {copyNotSupported(); return nullptr;}

    virtual std::string str() const override {return "";}

    virtual void parsimPack(cCommBuffer *buffer) const override  {throw cRuntimeError(this, E_CANTPACK);}

    virtual void parsimUnpack(cCommBuffer *buffer) override  {throw cRuntimeError(this, E_CANTPACK);}

    virtual cNedValue evaluate(Context *context) const = 0;

    virtual bool boolValue(Context *context) const = 0;

    virtual intpar_t intValue(Context *context, const char *expectedUnit=nullptr) const = 0;

    virtual double doubleValue(Context *context, const char *expectedUnit=nullptr) const = 0;

    virtual std::string stringValue(Context *context) const = 0;

    virtual cXMLElement *xmlValue(Context *context) const = 0;

    virtual cNedValue evaluate(cComponent *contextComponent=nullptr) const;

    virtual bool boolValue(cComponent *contextComponent=nullptr) const;

    virtual intpar_t intValue(cComponent *contextComponent=nullptr, const char *expectedUnit=nullptr) const;

    virtual double doubleValue(cComponent* contextComponent=nullptr, const char *expectedUnit=nullptr) const;

    virtual std::string stringValue(cComponent *contextComponent=nullptr) const;

    virtual cXMLElement *xmlValue(cComponent *contextComponent=nullptr) const;

    virtual void parse(const char *text) = 0;

    virtual int compare(const cExpression *other) const = 0;

    virtual bool containsConstSubexpressions() const = 0;

    virtual void evaluateConstSubexpressions(Context *context) = 0;
};

}  // namespace omnetpp


#endif