gmSaveResultsRule.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_SAVE_RESULTS_RULE_H_
#define _GEMA_SAVE_RESULTS_RULE_H_
 
#include "gmResultsRule.h"
#include "gmResultsDataSrcInfo.h"
#include "gmCoreConfig.h"
 
#include <QVariant>
#include <QSet>
#include <fstream>      // std::ofstream
 
class GmSimulationData;
class GmFileIO;
 
 
class GMC_API_EXPORT GmSaveResultsRule : public GmResultsRule
{
public:
    enum GmSimpleSaveFormat {
        GM_REPORT,
        GM_HISTORY,
    };
 
  virtual ~GmSaveResultsRule();
 
  // See commets on the base class
  virtual GmResultsRuleType type() const { return GM_RESULTS_SAVE_RULE; }
 
  virtual void print(const GmLogCategory& logger, GmLogLevel level) const;
 
  virtual bool run(const GmLogCategory& logger);
 
  static GmSaveResultsRule* loadFromTable(const GmResultsData* data, LuaTable& tab, const GmLogCategory& parseLogger, const GmSimulationData* simData);
 
private:
  Q_DISABLE_COPY(GmSaveResultsRule);
 
  GmSaveResultsRule(QString id, QString description, const QVector<GmResultsDataSet*>& dataSets,
                    const QVector<GmResultsTimeSet*>& timeSets, QString outputFile, 
                    const QVariantMap& formatOptions, bool trackObj, const GmSimulationData* simData);
 
  bool fileIOInit(const GmLogCategory& logger);
  bool fileIOSave(const GmLogCategory& logger);
 
  template <class T>
  void fileIOCheckAndAddDataSrcs(const GmResultsDataSet* dset, GmResultsDataSrcType type, QString typeStr, 
                                 QSet<QString>& idSet, QVector<const T*>&  data, QStringList& groups, 
                                 bool& tryGroups, bool warn, const GmLogCategory& logger);
 
  bool simpleInit(const GmLogCategory& logger);
  bool simpleSave(const GmLogCategory& logger);
  void simpleWriteReportData          (const GmResultsDataSet* dataSet);
  void simpleWriteHistoryEvalSetHeader(const GmResultsDataSet* dataSet);
  void simpleWriteHistoryEvalSetData  (const GmResultsDataSet* dataSet);
 
  enum ReadyState
  {
    FILE_INIT_PENDING,  
    FILE_OK,            
    FILE_DONE,          
    FILE_ERROR,         
  };
 
  QString                 _outputFileName; 
  QVariantMap             _formatOptions;  
  ReadyState              _fileState;      
 
  GmFileIO*               _fileIo;                  
  bool                    _fileIoSingleTime;        
  bool                    _fileIoCloseOnTimeSetEnd; 
 
  std::fstream            _simpleFile;        
  GmSimpleSaveFormat      _simpleFormat;      
  bool                    _simpleWriteHeader; 
  QString                 _simpleSep;         
};
#endif