gmProcess.h

Go to the documentation of this file.

/************************************************************************
**
** Copyright (C) 2014 by Carlos Augusto Teixera Mendes
** All rights reserved.
**
** This file is part of the "GeMA" software. It's use should respect
** the terms in the license agreement that can be found together
** with this source code.
** It is provided AS IS, with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE.
**
************************************************************************/
 
#ifndef _GEMA_PROCESS_H_
#define _GEMA_PROCESS_H_
 
#include "gmPluginObject.h"
#include "gmPluginCategory.h"
 
#include "gmProcessMethodRedirector.h"
#include "gmSimulationData.h"
 
#include <luaTable.h>
 
class GmRunProgressStats;
 
class GMC_API_EXPORT GmProcess : public GmPluginObject
{
public:
  GmProcess(GmSimulationData* simulation, QString id, QString description, const GmLogCategory& logger);
  virtual ~GmProcess();
 
  // Comments on the base class
  virtual const char* pluginCategory() const { return GM_PLUGIN_PROCESS; }
 
  virtual bool loadPrivateData(LuaTable& table);
  virtual void printParameters(const GmLogCategory& logger);
 
  virtual void loadFunctions(LuaTable& table) = 0;
 
  virtual QStringList functionList() const = 0;
 
  int createProgressStatsItem(GmRunProgressStats* ps, const char* name);
 
protected:
  template <class T> void registerFunctions(LuaTable& table, typename GmProcessMethodRedirector<T>::MethodRegistry* methods, bool noProgressStats = false)
  {
    lua_State* L = table.env()->state();
    table.push();
    GmProcessMethodRedirector<T>::registerMethods(L, methods, (T*)this, noProgressStats ? NULL : simulationData()->progressStats());
    lua_pop(L, 1);
  }
 
  template <class T> QStringList buildFunctionList(typename GmProcessMethodRedirector<T>::MethodRegistry* methods) const
  {
    QStringList list;
    typename GmProcessMethodRedirector<T>::MethodRegistry* r; //Linux needs this
    for(r = methods; r->_name; ++r)
      list.append(r->_name);
    return list;
  }
 
private:
  int _processProgressItem; 
};
 
#endif