cnedmathfunction.h

//==========================================================================
//  CMATHFUNCTION.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_CMATHFUNCTION_H
#define __OMNETPP_CMATHFUNCTION_H

#include <cstdarg>
#include "simkerneldefs.h"
#include "globals.h"
#include "cownedobject.h"

namespace omnetpp {


typedef double (*MathFunc)(...);

typedef double (*MathFuncNoArg)();

typedef double (*MathFunc1Arg)(double);

typedef double (*MathFunc2Args)(double,double);

typedef double (*MathFunc3Args)(double,double,double);

typedef double (*MathFunc4Args)(double,double,double,double);


class SIM_API cNedMathFunction : public cNoncopyableOwnedObject
{
  private:
    MathFunc f;            // pointer to the function
    int argc;              // argument count (up to 4 doubles)
    std::string category;  // category string; only used when listing all functions
    std::string description;  // optional documentation string

  public:
    cNedMathFunction(const char *name, MathFuncNoArg f, int argc=-1, const char *category=nullptr, const char *description=nullptr);

    cNedMathFunction(const char *name, MathFunc1Arg f, int argc=-1, const char *category=nullptr, const char *description=nullptr);

    cNedMathFunction(const char *name, MathFunc2Args f, int argc=-1, const char *category=nullptr, const char *description=nullptr);

    cNedMathFunction(const char *name, MathFunc3Args f, int argc=-1, const char *category=nullptr, const char *description=nullptr);

    cNedMathFunction(const char *name, MathFunc4Args f, int argc=-1, const char *category=nullptr, const char *description=nullptr);

    virtual ~cNedMathFunction() {}

    virtual std::string str() const override;

    int getNumArgs() const  {return argc;}

    MathFunc getMathFunc() const {return f;}

    MathFuncNoArg getMathFuncNoArg() const;

    MathFunc1Arg getMathFunc1Arg() const;

    MathFunc2Args getMathFunc2Args() const;

    MathFunc3Args getMathFunc3Args() const;

    MathFunc4Args getMathFunc4Args() const;

    const char *getCategory() const  {return category.c_str();}

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

    static cNedMathFunction *find(const char *name, int numArgs);

    static cNedMathFunction *get(const char *name, int numArgs);

    static cNedMathFunction *findByPointer(MathFunc f);

};

// cNEDMathFunction was renamed cNedMathFunction in OMNeT++ 5.3; typedef added for compatibility
typedef cNedMathFunction cNEDMathFunction;

}  // namespace omnetpp


#endif