gmRunProgressStats.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_RUN_PROGRESS_STATS_H_
#define _GEMA_RUN_PROGRESS_STATS_H_
 
#include "gmResultsData.h"
#include "gmThreadManager.h"
 
#include <unit.h>
#include <qtPtrList.h>
 
class GmResultsData;
class Unit;
class GmRunProgressStatsItem;
class GmRunProgressReport;
 
class GMC_API_EXPORT GmRunProgressStats : public QObject
{
  Q_OBJECT
 
public:
 
  enum Level {
    GM_RUNPROG_DISABLED,  
    GM_RUNPROG_NS_SP,     
    GM_RUNPROG_NS_DP,     
    GM_RUNPROG_DS_SP,     
    GM_RUNPROG_DS_DP,     
    //-------------------------------
    // Don't insert items below this line
    GM_RUNPROG_NUM_LEVELS
  };
 
  enum TrackOptions {
    GM_RUNPROG_TRACK_TIME             = 0x0001,  
    GM_RUNPROG_TRACK_MEM              = 0x0002,  
    GM_RUNPROG_TRACK_REPORT_AT_END    = 0x0004,  
    GM_RUNPROG_TRACK_REPORT_STATS     = 0x0008,  
    GM_RUNPROG_TRACK_STATS_MIN        = 0x0010,  
    GM_RUNPROG_TRACK_STATS_MAX        = 0x0020,  
    GM_RUNPROG_TRACK_STATS_AVG        = 0x0040,  
    GM_RUNPROG_TRACK_STATS_TOTAL      = 0x0080,  
    GM_RUNPROG_TRACK_STATS_ALL        = 0x00F0,  
    GM_RUNPROG_TRACK_ATTR_DEFAULT     = 0x0100,  
    GM_RUNPROG_TRACK_DEFAULT          = GM_RUNPROG_TRACK_TIME | GM_RUNPROG_TRACK_REPORT_STATS | 
                                        GM_RUNPROG_TRACK_STATS_ALL,
  };
 
  GmRunProgressStats(GmResultsData* resultsData);
 
  ~GmRunProgressStats();
 
  static void setLevelConfiguration(QString item, Level level) 
  { 
    if(item == ":default")
      _defLevel = level;
    else
      _levelMap[item] = level; 
  }
 
  static Level defLevel() { return _defLevel; }
 
  static Level configuredLevel(QString item)  { return _levelMap.value(item, _defLevel); }
 
  static int itemOptionsFromLevel(QString item, bool mem = false, bool* detailedStats = NULL);
 
  int     registerItem(const QObject* owner, int fatherItemId, QString name, int options = GM_RUNPROG_TRACK_DEFAULT, QString autoId = "");
  QString itemName    (int itemId) const;
  int     findItem    (int fatherItemId, QString name) const;
  bool    renameItem  (int itemId, QString autoId);
 
  bool validItemId(int itemId) const { return itemId >= 0 && itemId < _items.listSize() && _items[itemId]; }
 
  const QObject* itemOwner(int itemId) const;
 
  void setItemData(int itemId, void* data);
 
  void registerNestedItem(int trackingItemId, int trackedItemId);
 
  int registerAttribute(int itemId, QString name, QString description, Unit unit, int nlin, int ncol,
                        QString format, int statOptions = GM_RUNPROG_TRACK_ATTR_DEFAULT)
  {
    assert(validItemId(itemId));
    return registerAttribute(_items[itemId], name, description, unit, nlin, ncol, format, statOptions);
  }
 
  int registerScalarAttribute(int itemId, QString name, QString description, Unit unit, QString format,
                              int statOptions = GM_RUNPROG_TRACK_ATTR_DEFAULT)
  {
    return registerAttribute(itemId, name, description, unit, 1, 1, format, statOptions);
  }
 
  int registerCounterAttribute(int itemId, QString name, QString description, int statOptions = GM_RUNPROG_TRACK_ATTR_DEFAULT)
  {
    return registerAttribute(itemId, name, description, Unit(), 1, 1, ".0f", statOptions);
  }
 
  int registerStringAttribute(int itemId, QString name, QString description, int statOptions = GM_RUNPROG_TRACK_ATTR_DEFAULT)
  {
    return registerAttribute(itemId, name, description, Unit(), 0, 0, "", statOptions);
  }
 
  inline int attr(int itemId, int attrId) const; // Can not be defined in the .h due to undefined Item type -- including the header would create a cycle :( 
 
  GmAttributeResultsManager* attrManager() const { return _attrm; }
 
  int findAttribute(int itemId, QString name) const;
  int findAttribute(int itemId, int nestedId, QString name) const;
 
  int autoTimeItemAttribute(int itemId) const;
  int autoMemItemAttribute (int itemId) const;
 
  GmRunProgressReport* addNewReport(QString title, QString fileName, bool itemColumn = false);
  void                 addReportToItem(GmRunProgressReport* report, int itemId, QString itemReportDescription);
  GmRunProgressReport* report(QString fileName) const;
 
  void itemStart(int itemId);
  void itemEnd  (int itemId);
 
  QString strAttributeValue(int itemId, int attrId) const { return _attrm->resultAttributeString(attr(itemId, attrId)); }
 
  const double* numericAttributeValue(int itemId, int attrId) const { return _attrm->resultAttributeBuffer(attr(itemId, attrId)); }
 
 
  void setAttributeValue(int itemId, int attrId, double val) { _attrm->setResultAttributeValue(attr(itemId, attrId), val); }
 
  void setAttributeValue(int itemId, int attrId, double val1, double val2) { _attrm->setResultAttributeValue(attr(itemId, attrId), val1, val2); }
 
  void setAttributeValue(int itemId, int attrId, double val1, double val2, double val3) { _attrm->setResultAttributeValue(attr(itemId, attrId), val1, val2, val3); }
 
  void setAttributeValue(int itemId, int attrId, const double* val) { _attrm->setResultAttributeValue(attr(itemId, attrId), val); }
 
  void setAttributeValue(int itemId, int attrId, const GmVector& val) { _attrm->setResultAttributeValue(attr(itemId, attrId), val); }
 
  void setAttributeValue(int itemId, int attrId, const GmMatrix& val) { _attrm->setResultAttributeValue(attr(itemId, attrId), val); }
 
  void setAttributeValue(int itemId, int attrId, int val) { _attrm->setResultAttributeValue(attr(itemId, attrId), (double)val); }
 
  void setAttributeValue(int itemId, int attrId, unsigned val) { _attrm->setResultAttributeValue(attr(itemId, attrId), (double)val); }
 
  void setAttributeValue(int itemId, int attrId, QString val) { _attrm->setResultAttributeValue(attr(itemId, attrId), val); }
 
  void setAttributeValue(int itemId, int attrId, const char* val) { _attrm->setResultAttributeValue(attr(itemId, attrId), QString(val)); }
 
  void incAttributeValue(int itemId, int attrId)
  { 
    const double* v = _attrm->resultAttributeBuffer(attr(itemId, attrId));
    _attrm->setResultAttributeValue(attr(itemId, attrId), *v + 1);
  }
 
  void decAttributeValue(int itemId, int attrId)
  {
    const double* v = _attrm->resultAttributeBuffer(attr(itemId, attrId));
    _attrm->setResultAttributeValue(attr(itemId, attrId), *v - 1);
  }
 
  void reportStats(QString finalStatusStr, qint64 runTime);
  void csvStats   (QString csvFile, bool add, bool totalOnly, const QStringList& filters, QString simName, qint64 runTime);
 
 
  void removeRegisteredItem(int itemId);
 
public slots:
  void removeRegisteredItems(QObject* owner);
 
private:
  Q_DISABLE_COPY(GmRunProgressStats);
 
  inline int attr(const GmRunProgressStatsItem* item, int attrId) const;
 
  QString parseItemName(int fatherId, QString name, QString autoId) const;
 
  int registerAttribute(GmRunProgressStatsItem* item, QString name, QString description, 
                        Unit unit,int nlin, int ncol, QString format, int statOptions);
 
  void csvStatsFillReportData (bool totalOnly, const QStringList& filters, qint64 runTime, 
                               QStringList& attrList, QStringList& unitList, QStringList& dataList) const;
  bool csvStatsParseReportData(QString fileName, QString attrHeader, QString unitHeader, int numDataCols, QString dataHeader,
                               QStringList& attrList, QStringList& unitList, QStringList& dataList, QStringList& nameList) const;
 
  QString itemStr    (const GmRunProgressStatsItem* item, int attrId) const;
  QString itemStatStr(const GmRunProgressStatsItem* item, int attrId) const;
 
  void addReportTraillers() const;
 
  GmResultsData*             _resultsData;  
  GmAttributeResultsManager* _attrm;        
  GmLogCategory              _logger;       
 
  QtPtrList<GmRunProgressStatsItem> _items;    
  QMap<QString, int>                _itemsMap; 
  static QMap<QString, Level>       _levelMap; 
  static Level                      _defLevel; 
  QVector<GmRunProgressReport*>     _reports;  
}; 
 
class GmRunProgress
{
public:
  GmRunProgress(GmRunProgressStats* ps, int itemId) : _ps(itemId >= 0 ? ps : NULL), _itemId(itemId)
  {
    if(_ps)
      _ps->itemStart(itemId);
  }
 
  ~GmRunProgress() { if(_ps) _ps->itemEnd(_itemId); }
 
  QString       strAttributeValue    (int attrId) const { return _ps ? _ps->strAttributeValue    (_itemId, attrId) : ""; }
  const double* numericAttributeValue(int attrId) const { return _ps ? _ps->numericAttributeValue(_itemId, attrId) : NULL; }
 
  void setAttributeValue(int attrId, double val)                            { if(_ps) _ps->setAttributeValue(_itemId, attrId, val); }
  void setAttributeValue(int attrId, double val1, double val2)              { if(_ps) _ps->setAttributeValue(_itemId, attrId, val1, val2); }
  void setAttributeValue(int attrId, double val1, double val2, double val3) { if(_ps) _ps->setAttributeValue(_itemId, attrId, val1, val2, val3); }
  void setAttributeValue(int attrId, const double* val)   { if(_ps) _ps->setAttributeValue(_itemId, attrId, val); }
  void setAttributeValue(int attrId, const GmVector& val) { if(_ps) _ps->setAttributeValue(_itemId, attrId, val); }
  void setAttributeValue(int attrId, const GmMatrix& val) { if(_ps) _ps->setAttributeValue(_itemId, attrId, val); }
  void setAttributeValue(int attrId, int val)             { if(_ps) _ps->setAttributeValue(_itemId, attrId, val); }
  void setAttributeValue(int attrId, unsigned val)        { if(_ps) _ps->setAttributeValue(_itemId, attrId, val); }
  void setAttributeValue(int attrId, QString val)         { if(_ps) _ps->setAttributeValue(_itemId, attrId, val); }
  void setAttributeValue(int attrId, const char* val)     { if(_ps) _ps->setAttributeValue(_itemId, attrId, val); }
  void incAttributeValue(int attrId) { if(_ps) _ps->incAttributeValue(_itemId, attrId); }
  void decAttributeValue(int attrId) { if(_ps) _ps->decAttributeValue(_itemId, attrId); }
 
protected:
  GmRunProgressStats* _ps;     
  int                 _itemId; 
};
 
class GmRunProgressOnMainThread : GmRunProgress
{
public:
  GmRunProgressOnMainThread(GmRunProgressStats* ps, int itemId) : GmRunProgress(GmThreadManager::inMainThread() ? ps : NULL, itemId) {}
};
 
#endif