gmValueSet.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_VALUE_SET_H_
#define _GEMA_VALUE_SET_H_

#include "gmCoreConfig.h"
#include "gmValueSetData.h"
#include "gmValueInfo.h"

#include <QVarLengthArray>
#include <assert.h>

#include <QObject>

class GmValueAccessor;
class GmSimulationData;
class GmMesh;
class GmLogCategory;
class GmValueSetEvalContext;
class GmValueSetData;
class Unit;


// Enable the define bellow to force validation of internal structures after value set initialization or growth
// #define ENABLE_VALUESET_TESTS


class GMC_API_EXPORT GmValueSet : public QObject
{
  Q_OBJECT
public:

  enum SaveStateMode
  {
    VS_NOINIT_VALUES,  
    VS_INIT_VALUES,    
    VS_COPY_VALUES,    
  };

  GmValueSet(GmValueInfo* info, GmSimulationData* simData, GmMesh* mesh);
  virtual ~GmValueSet();

  bool init(int numValues, bool releaseInfoOnError = false);

  GmValueInfo* info() const { return _info; }
  
  int numValues() const { assert(!_vsDataList.isEmpty()); return _vsDataList.first()->numValues(); }

  bool addValues(int numAddedValues);
  void restoreSize(int oldNumValues);

  virtual void removeValues(int index, int numValues);

  virtual void clear();

  GmValueAccessor* accessor(const Unit& desiredUnit, const GmLogCategory& logger, const GmMesh* mesh = NULL)
  {
    return accessor(0, true, desiredUnit, logger, mesh);
  }

  GmValueAccessor* accessor(int snum, bool locked, const Unit& desiredUnit, const GmLogCategory& logger, const GmMesh* mesh = NULL);

  virtual bool saveState(SaveStateMode mode, const GmLogCategory& logger);

  int numSets() const { return _vsDataList.size(); }

  GmValueSetData* valueSetData(int sindex, bool locked) const { return _vsDataList.at(locked ? t(sindex) : sindex); }

  void replaceValueSetData(GmValueSetData* oldData, GmValueSetData* newData);

  GmValueSetEvalContext* evalContext() const { return _evalContext; }

  QString stateTag(int snum) const { return _tagList.at(t(snum)); }

  double stateTime(int snum) const { return _timeList.at(t(snum)); }

  void setStateTag(int snum, QString tag) { _tagList[t(snum)] = tag; }

  void setStateTime(int snum, double time) { _timeList[t(snum)] = time; }

#if defined ENABLE_TESTS || defined ENABLE_VALUESET_TESTS
  virtual void validateInternalStructure();
#endif

  virtual size_t printMemoryStatistics(const GmLogCategory& logger, GmLogLevel level) const;
  virtual size_t usedMemory() const;

signals:
  void setDataChanged(const GmValueSet* vs);

protected:
  GmValueSetData* vd(int snum) const { return _vsDataList.at(t(snum)); }

  int t(int index) const
  {
    int n = _vsDataList.size();
    assert(index >= 0 && index < n);
    return (_info->history() > 0) ? (_currentSet + index) % n : n - index - 1;
  }

  GmValueSetData* createDataObject();

  GmValueInfo*           _info;        
  GmValueSetEvalContext* _evalContext; 

  QList<GmValueSetData*> _vsDataList;  
  QStringList            _tagList;     
  QList<double>          _timeList;    
  int                    _currentSet;  

private:
  Q_DISABLE_COPY(GmValueSet)
};

#endif