gmResultsRule.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_RESULTS_RULE_H_
#define _GEMA_RESULTS_RULE_H_
 
#include "gmCoreConfig.h"
#include "gmLog.h"
 
#include <QString>
#include <QVector>
 
class LuaTable;
class GmResultsData;
class GmResultsDataSet;
class GmResultsTimeSet;
class GmSimulationData;
 
enum GmResultsRuleType
{
  GM_RESULTS_SAVE_RULE,     
  GM_RESULTS_PRINT_RULE,    
  GM_RESULTS_MONITOR_RULE,  
};
 
class GMC_API_EXPORT GmResultsRule
{
public:
 
  virtual ~GmResultsRule();
 
  QString id() const { return _id; }
 
  QString description() const { return _description; }
 
  virtual GmResultsRuleType type() const = 0;
 
  const QVector<GmResultsDataSet*>& dataSets() const { return _dataSets; }
 
  const QVector<GmResultsTimeSet*>& timeSets() const { return _timeSets; }
 
  bool hasTimeSet() const { return !_timeSets.isEmpty(); }
 
  virtual void print(const GmLogCategory& logger, GmLogLevel level) const;
 
  virtual bool run(const GmLogCategory& logger) = 0;
 
protected:
  GmResultsRule(QString id, QString description, const QVector<GmResultsDataSet*>& dataSets, 
                const QVector<GmResultsTimeSet*>& timeSets, bool trackObj, const GmSimulationData* simData);
 
  static bool fillCommonFields(const GmResultsData* data, LuaTable& tab, const GmLogCategory& logger,
                               QString& id, QString& description, QVector<GmResultsDataSet*>& dataSets,
                               QVector<GmResultsTimeSet*>& timeSets, bool& trackObj);
 
  QString _id;              
  QString _description;     
 
  QVector<GmResultsDataSet*> _dataSets; 
  QVector<GmResultsTimeSet*> _timeSets; 
 
  const GmSimulationData* _simData;     
  int                     _itemId;      
  int                     _objItemId;   
 
private:
  Q_DISABLE_COPY(GmResultsRule);
 
};
#endif