gmSimulationData.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_SIMULATION_DATA_H_
#define _GEMA_SIMULATION_DATA_H_
 
#include "gmCoreConfig.h"
#include "gmThreadManager.h"
#include "gmResultsData.h"
#include "gmPluginObject.h"
 
#include <unit.h>
 
#include <QString>
#include <QVariant>
#include <assert.h>
 
class GmModelData;
class GmSolutionData;
class GmRunProgressStats;
 
class GmPath;
class GmPluginLoader;
class GmLogCategory;
 
class GmTaskManager;  
class GmMpiContext;
 
struct QtHardwareInfo;  
struct QtGlobalMemUsage;
 
 
class GMC_API_EXPORT GmSimulationData
{
public:
  GmSimulationData(GmPluginLoader* loader, const GmPath* paths, 
                   const QVariantMap& configConstants, const QVariantMap& configOptions);
  ~GmSimulationData();
 
  void init();
  void clearData();
 
  QString name() const { return _name; }
 
  QString description() const { return _description; }
 
  const QStringList& loadedFiles() const { return _loadedFiles; }
 
  void setSimulationGlobalInfo(QString name, QString description, 
                               const QVariantMap& constants, const QVariantMap& options)
  {
    _name        = name;
    _description = description;
    _constants   = constants;
    _options     = options;
    setupDisabledWarningsList();
  }
 
  void setLoadedFiles(const QStringList& loadedFiles) { _loadedFiles = loadedFiles; }
 
  void setSharedCode(QString sharedCode) { _sharedCode = sharedCode; }
 
  GmModelData* modelData() const { return _model; }
 
  GmSolutionData* solutionData() const { return _solution; }
 
  GmResultsData* resultsData() const { return _results; }
 
  GmRunProgressStats* progressStats() const { return _progress; }
 
  static GmRunProgressStats* progressStats(const GmPluginObject* obj) { return obj->simulationData()->progressStats(); }
 
  QString sharedCode() const { return _sharedCode; }
 
  GmPluginLoader* loader() const { return _loader; }
 
  const GmPath* paths() const { return _paths; }
 
  void printInfo();
 
  bool cancelRequested() const { assert(_threadManager);  return _threadManager->cancelRequested(); }
 
  GmThreadManager* threadManager() const { return _threadManager; }
 
  GmTaskManager* taskManager() const { return _taskManager; }
 
  GmMpiContext* mpiContext() const { return _mpiContext; }
 
  QtHardwareInfo* hwInfo() const { return _hwInfo; } 
 
  double currentTime() const { return _currentTime; }
 
  double previousTime() const { return _prevTime; }
 
  double currentTime (const Unit& desiredUnit) const;
  double previousTime(const Unit& desiredUnit) const;
 
  const Unit& timeUnit() const { return _timeUnit; }
 
  void setCurrentTime(double time, bool updatePrev = true)
  {
    assert(GmThreadManager::inMainThread());
    if(updatePrev)
      _prevTime = (time == 0.0 ? 0.0 : _currentTime);
    _currentTime = time;
 
    _results->setCurrentTime(_currentTime);
  }
 
  void setPreviousTime(double time) { assert(GmThreadManager::inMainThread()); _prevTime = time; }
 
  void setCurrentTimeUnit(const Unit& unit) { assert(GmThreadManager::inMainThread()); _timeUnit = unit; }
 
  bool disabledWarning(QString warnName) const { return _disabledWarnings.contains(warnName); }
 
  void pushDisabledWarning(QString warnName) { _disabledWarnings.append(warnName); }
 
  void popDisabledWarning() { assert(!_disabledWarnings.isEmpty()); _disabledWarnings.removeLast(); }
 
  const QVariant& optionValue(const QString& name) const { return mapValue(name, _options, _configOptions); }
 
  QVariant optionValue(const QString& name, const QVariant& defValue) const { return mapValue(name, _options, _configOptions, defValue); }
 
  const QVariant& constantValue(const QString& name) const { return mapValue(name, _constants, _configConstants); }
 
  QVariant constantValue(const QString& name, const QVariant& defValue) const { return mapValue(name, _constants, _configConstants, defValue); }
 
  const QVariantMap& simulationOptions() const { return _options; }
 
  const QVariantMap& simulationConstants() const { return _constants; }
 
  const QVariantMap& configOptions() const { return _configOptions; }
 
  const QVariantMap& configConstants() const { return _configConstants; }
 
private:
  void createStdProgressItems();
 
  QString variantToString  (const QVariant& v);
  void    printMapValues   (const GmLogCategory& logger, const QVariantMap& map, const QVariantMap& configMap);
  void    printHardwareInfo(const GmLogCategory& logger);
 
  const QVariant& mapValue(const QString& name, const QVariantMap& map, const QVariantMap& configMap) const;
  QVariant        mapValue(const QString& name, const QVariantMap& map, const QVariantMap& configMap, const QVariant& defValue) const;
 
  void setupDisabledWarningsList() { _disabledWarnings = mapValue("disabledWarnings", _options, _configOptions, QStringList()).toStringList(); }
 
  QString             _name;             
  QString             _description;      
  QStringList         _loadedFiles;      
  QVariantMap         _constants;        
  QVariantMap         _options;          
  const QVariantMap&  _configConstants;  
  const QVariantMap&  _configOptions;    
  QStringList         _disabledWarnings; 
                      
  GmModelData*        _model;           
  GmSolutionData*     _solution;        
  GmResultsData*      _results;         
  GmRunProgressStats* _progress;        
 
  QString             _sharedCode;      
                      
  QtHardwareInfo*     _hwInfo;          
  QtGlobalMemUsage*   _initMemoryInfo;  
                      
  GmThreadManager*    _threadManager;   
  GmTaskManager*      _taskManager;     
 
  GmMpiContext*       _mpiContext;      
                      
  GmPluginLoader*     _loader;     
  const GmPath*       _paths;      
 
  double _currentTime;  
  double _prevTime;     
  Unit   _timeUnit;     
};
 
#endif