gmAttributeResultsManager.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_ATTRIBUTE_RESULTS_MANAGER_H_
#define _GEMA_ATTRIBUTE_RESULTS_MANAGER_H_
 
#include "gmCoreConfig.h"
 
#include "gmAttributeResultsDataSrcInfo.h"
#include "gmVector.h"
#include "gmMatrix.h"
 
class GmResultsData;
class GmResultsDataSet;
class GmAttributeResultsDataSrcInfo;
class GmAttributeResultsDataSrc;
 
#include <qtPtrList.h>
#include <QObject>
#include <QMap>
 
class GMC_API_EXPORT GmAttributeResultsManager : public QObject
{
  Q_OBJECT
 
public:
  GmAttributeResultsManager(GmResultsData* resultsData)
    : _resultsData(resultsData), 
      _monitor(false),
      _resultAttributes(true) // true to make the list own the stored pointers
  {}
 
  ~GmAttributeResultsManager() { clear(); }
 
  void clear();
 
  void enableMonitoring() { _monitor = true; }
 
  int registerResultAttribute(const QObject* owner, QString name, QString description, Unit unit,
                              int nlin, int ncol, QString format, int stats);
 
  void removeResultAttribute(int id);
  bool renameResultAttribute(int id, QString newName);
 
  bool registerAttributeDataSrc(GmResultsDataSet* dataSet, GmAttributeResultsDataSrc* ds, QString& err);
 
  void updateRegisteredAttributeDataSrc(GmResultsDataSet* dataSet, GmAttributeResultsDataSrc* ds);
 
  void removeAttributeDataSet(GmResultsDataSet* dataSet);
 
  void setResultAttributeValue(int id, double val);
  void setResultAttributeValue(int id, double val1, double val2);
  void setResultAttributeValue(int id, double val1, double val2, double val3);
  void setResultAttributeValue(int id, const double* val);
  void setResultAttributeValue(int id, const GmVector& val);
  void setResultAttributeValue(int id, const GmMatrix& val);
  void setResultAttributeValue(int id, QString val);
 
  void clearAttributeStatistics (int id);
  void updateAttributeStatistics(int id);
 
  bool isValidAttributeId(int id) const { return id >= 0 && id < _resultAttributes.listSize() && _resultAttributes[id]; }
 
  const QObject* attributeIdOwner(int id) const { return data(id)->_owner; }
 
  int resultAttributeId(QString name) const { return _resultAttributesMap.value(name, -1); }
 
  bool isNumericResult(int id) const { return info(id)->size(); } // String attributes have a 0 size
 
  const GmAttributeResultsDataSrcInfo* resultAttributeInfo(int id) const { return info(id); }
 
  const double* resultAttributeBuffer(int id) const
  {
    assert(isNumericResult(id));
    return info(id)->attributeStats() ? value(id)._statValue->_value :
                                        value(id)._numValue;
  }
 
  QString resultAttributeString(int id) const
  {
    assert(!isNumericResult(id));
    return *value(id)._strValue;
  }
 
  const double* resultAttributeStatisticsMinBuffer(int id) const
  {
    assert(isNumericResult(id));
    return info(id)->attributeStats() ? value(id)._statValue->_statMin : NULL;
  }
 
  const double* resultAttributeStatisticsMaxBuffer(int id) const
  {
    assert(isNumericResult(id));
    return info(id)->attributeStats() ? value(id)._statValue->_statMax : NULL;
  }
 
  const double* resultAttributeStatisticsSumBuffer(int id) const
  {
    assert(isNumericResult(id));
    return info(id)->attributeStats() ? value(id)._statValue->_statSum : NULL;
  }
 
  quint64 resultAttributeStatisticsCount(int id) const
  {
    assert(isNumericResult(id));
    return info(id)->attributeStats() ? value(id)._statValue->_statCount : 0;
  }
 
signals:
  void attributeRegistered(int id, QString name);
 
  void attributeUnregistered(int id, QString name);
 
private slots:
  void removeRegisteredAttributes(QObject* owner);
 
private:
  Q_DISABLE_COPY(GmAttributeResultsManager);
 
  struct AttrValueWithStats
  {
    double* _value;      
    double* _statMin;    
    double* _statMax;    
    double* _statSum;    
    quint64 _statCount;  
 
    AttrValueWithStats(int s);
    ~AttrValueWithStats();
    void zero(int s);
    void clearStats(int s);
    void updateStats(int s);
  };
 
  union AttrValue
  {
    double*             _numValue;   
    AttrValueWithStats* _statValue;  
    QString*            _strValue;   
 
    AttrValue() { _numValue = NULL; }
    void    init       (GmAttributeResultsDataSrcInfo* info);
    void    clear      (GmAttributeResultsDataSrcInfo* info);
    void    zero       (GmAttributeResultsDataSrcInfo* info);
    double* valueBuffer(GmAttributeResultsDataSrcInfo* info);
  };
 
  struct RegisteredAttrData
  {
    GmAttributeResultsDataSrcInfo* _info;   
    const QObject*                 _owner;  
    AttrValue                      _value;  
 
    QVector<QPair<GmResultsDataSet*, GmAttributeResultsDataSrc*>> _dataSrcList;
 
    QVector<GmAttributeResultsDataSrc*> _monitoredList;
    ~RegisteredAttrData();
  };
 
  inline RegisteredAttrData* data(int id) const { assert(isValidAttributeId(id));  return _resultAttributes[id]; }
 
  inline GmAttributeResultsDataSrcInfo* info(int id) const { return data(id)->_info; }
 
  inline AttrValue& value(int id) const { return data(id)->_value; }
 
  void unregisteredToRegistered(RegisteredAttrData* ad, int attrId);
  void registeredToUnregistered(RegisteredAttrData* ad);
 
  void emitValueChanged(RegisteredAttrData* ad, double  val);
  void emitValueChanged(RegisteredAttrData* ad, QString val);
  void emitValueChanged(RegisteredAttrData* ad, const double* valList, int n);
 
 
  GmResultsData* _resultsData; 
 
  bool _monitor;  
 
  QMap<QString, int> _resultAttributesMap;
 
  QtPtrList<RegisteredAttrData> _resultAttributes;
 
  QMap<QString, QVector<QPair<GmResultsDataSet*, GmAttributeResultsDataSrc*>>> _unregisteredAttributes;
};
 
#endif