gmRunProgressReport.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_REPORT_H_
#define _GEMA_RUN_PROGRESS_REPORT_H_
 
#include "gmResultsData.h"
#include <unit.h>
#include <qtPtrList.h>
 
class GmResultsData;
class Unit;
class GmRunProgressStats;
class GmRunProgressStatsItem;
class GmRunProgressReport;
 
class GMC_API_EXPORT GmRunProgressReport
{
public:
 
  enum ColAlignment {
    GM_RUNPROG_REPORT_LEFT,   
    GM_RUNPROG_REPORT_CENTER, 
    GM_RUNPROG_REPORT_RIGHT,  
    GM_RUNPROG_REPORT_AUTO,   
  };
 
  using ValueFunctionT = std::function<void(GmRunProgressReport* report, int col, int itemId, void* itemUserData)>;
 
  GmRunProgressReport(GmResultsData* resultsData, QString fileName, const GmLogCategory& logger);
 
  ~GmRunProgressReport();
 
  QString fileName() const { return _fileName; }
 
  void setTitle(QString title) { _title = title; }
 
  void addItemDescription(QString description) { _itemDescriptions.append(description); }
 
  int addColumn(int itemId, int attrId, QString colTitle="", bool autoTimeUnit = false, int width = -1, ColAlignment align = GM_RUNPROG_REPORT_AUTO, int attrDim = -1);
  int addColumn(QString colTitle, QString colUnit, QString fmt = "", bool autoTimeUnit = false, int width = -1, ColAlignment align = GM_RUNPROG_REPORT_RIGHT);
 
  void setColumnValueFunction(int col, const ValueFunctionT& f);
  void setColumnIgnoreOnZero(int col);
 
  void setColumnValue(int col, int val);
  void setColumnValue(int col, double val);
  void setColumnValue(int col, const double* val, int size);
  void setColumnValue(int col, QString str);
 
  void saveReportLine(int itemId, void* itemUserData);
  void saveTrailler(QString traillerStr);
 
private:
  Q_DISABLE_COPY(GmRunProgressReport);
 
  void saveReportHeader();
  void saveFormattedHeader(bool title);
  void saveFormattedLine();
  void saveFormattedTrailler(QString traillerStr);
 
  void saveCsvHeader(bool title);
  void saveCsvLine();
  void saveCsvTrailler(QString traillerStr);
 
  struct ColData
  {
    QStringList    _title;     
    QString        _unit;      
    int            _width;     
    ColAlignment   _align;     
    QString        _fmt;       
    int            _autoTime;  
    int            _attrId;    
    int            _attrDim;   
    bool           _ignoreOnZero; 
    QString        _value;     
    ValueFunctionT _colValueFunction; 
  };
 
  QStringList prepareTitle     (QString title, QString unit) const;
  QStringList splitMultilineStr(QString title, bool trim) const;
  int         findColumnWidth  (const ColData& colData, int dataSize) const;
 
  QString     alignStr (QString str, int width, ColAlignment align) const;
 
  GmResultsData*       _resultsData;   
  GmRunProgressStats*  _ps;            
  const GmLogCategory& _logger;        
  QString              _fileName;      
  bool                 _csv;           
  FILE*                _file;          
  QString              _title;         
  QStringList          _itemDescriptions; 
  QVector<ColData>     _columns;       
  int                  _numHeaderRows; 
};
 
#endif