functiondefinition.h

//
// author
//
// Copyright (c) CSIRO 2015
//
#ifndef FUNCTIONDEFINITION_H_
#define FUNCTIONDEFINITION_H_

#include "plotsconfig.h"

#include <QString>

struct PlotFunctionResult;
struct PlotFunctionInfo;

class FunctionDefinition
{
public:
  FunctionDefinition(const QString &category, const QString &name, unsigned argc = 0, bool variadic = false);

  FunctionDefinition(const QString &category, const QString &name, const QString &description, unsigned argc = 0, bool variadic = false);

  virtual ~FunctionDefinition();

  inline const QString &category() const { return _category; }

  inline void setCategory(const QString &category) { _category = category; }

  inline const QString &name() const { return _name; }

  inline void setName(const QString &name) { _name = name; }

  inline const QString &displayName() const { return _displayName; }

  inline void setDisplayName(const QString &name) { _displayName = name; }

  inline const QString &description() const { return _description; }

  inline void setDesciption(const QString &description) { _description = description; }

  inline unsigned argc() const { return _argc; }

  inline void setArgc(unsigned count) { _argc = count; }

  inline bool variadic() const { return _variadic; }

  inline void setVariadic(bool variadic) { _variadic = variadic; }

  virtual void evaluate(PlotFunctionResult &result, double time, unsigned int argc, const double *argv, const PlotFunctionInfo &info, void *context) const = 0;

  virtual void *createContext() const;

  virtual void destroyContext(void *context) const;

  QString deduceDisplayName() const;

private:
  QString _category;    
  QString _name;        
  QString _displayName; 
  QString _description; 
  unsigned _argc;       
  bool _variadic;       
};

#endif // FUNCTIONDEFINITION_H_