gmPluginObject.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_PLUGIN_OBJECT_H_
#define _GEMA_PLUGIN_OBJECT_H_
 
#include "gmLog.h"
 
#include <QString>
 
class GmSimulationData;
class LuaTable;
 
 
class GMC_API_EXPORT GmPluginObject
{
public:
  GmPluginObject(GmSimulationData* simulation, QString id, QString description, const GmLogCategory& logger);
  
  virtual ~GmPluginObject() {}
 
  QString id() const { return _id; }
 
  QString description() const { return _description; }
 
  QString pluginTypeName() const { return QString(pluginName()) + "." + pluginType(); }
 
  virtual const char* pluginCategory() const = 0;
 
  virtual const char* pluginName() const = 0;
 
  virtual const char* pluginType() const = 0;
 
  virtual bool loadPrivateData(LuaTable& table) = 0;
  
  virtual void printParameters(const GmLogCategory& logger) = 0;
 
protected:
  virtual const GmLogCategory& logger() const { return _logger; }
 
  GmSimulationData* simulationData() const { return _simData; }
 
private:
  friend class GmSimulationData; // Allow GmSimulationData::progressStats(const GmPluginObject*) to access simulationData()
 
  GmSimulationData* _simData;      
  QString           _id;           
  QString           _description;  
 
  const GmLogCategory& _logger;    
};
 
#endif