gmValueSetData.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_DATA_H_
#define _GEMA_VALUE_SET_DATA_H_

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


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


class GmTrackedValueAccessor;
class GmValueSet;
class UnitConverter;
class GmLogCategory;
class GmUserFunction;
class GmValueSetEvalContext;
class GmNanBoxedValue;

template <class T, bool Align> class GmTLBuffer;

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

//----------------------------------------------------------------------
//  GmValueSetData - Basic interface
//----------------------------------------------------------------------

class GMC_API_EXPORT GmValueSetData
{
public:
  enum StoredValueType
  {
    GM_SVT_NUMBER,        
    GM_SVT_FUNCTION,      
    GM_SVT_FUNCTION_EVAL, 
  };

  virtual ~GmValueSetData() {};

  virtual GmValueInfo* info() const = 0;

  virtual bool init(int numValues) = 0;

  virtual int numValues() const = 0;

  virtual bool addValues(int numAddedValues) = 0;

  virtual void restoreSize(int oldNumValues) = 0;

  virtual void removeValues(int index, int numValues) = 0;

  virtual void clear() = 0;

  virtual GmTrackedValueAccessor* accessor(const GmLogCategory& logger, UnitConverter* conv, 
                                           QString desiredUnit, bool atomic = false) = 0;

  virtual size_t usedMemory() const = 0;

#if defined ENABLE_TESTS || defined ENABLE_VALUESETDATA_TESTS
  virtual void validateInternalStructure() = 0;
#endif

protected:
  // Functions bellow are part of the cooperative interface between a ValueSetData and the 
  // ValueSetDataAccessor familly of classes.  They are marked protected since they are not 
  // intended for beeing used by users of ValueSetData, who should always access and store
  // values through accessors.
  template <class T> friend class GmValueSetDataAccessorBase;
  template <class T> friend class GmValueSetDataAccessor;
  template <class T> friend class GmNoFunctionValueSetDataAccessor;
  template <class T> friend class GmUnitConversionDataAccessor; // The unit conversion versions of the above classes
  friend class GmDefValueValueSetData;
  // The same logic applies for the state dumping and HDF5 saving classes that access the dump 
  // buffer interface functions for better performance
  friend class GmStateDumpValueSetDataItem;
  friend class GmHdf5;

  virtual bool isDefValue(int index) const = 0;

  virtual StoredValueType storedValueType(int index) const = 0;

  virtual const double* value(int index) const = 0;

  virtual bool setValue(int index, const double* values) = 0;

  virtual void* functionValue(int index) const = 0;

  virtual bool setFunctionValue(int index, StoredValueType type, void* functionObj) = 0;

  virtual char* dumpBuffer() { return NULL; }

  virtual int dumpBufferSize() const { return 0; }
};

//----------------------------------------------------------------------
//  GmVectorValueSetData<T> - Vector storage for non sparse, non function sets
//----------------------------------------------------------------------

template <class T> class GmVectorValueSetData : public GmValueSetData
{
public:
  GmVectorValueSetData(GmValueInfo* info);
  virtual ~GmVectorValueSetData();

  // See comments on the base class
  virtual GmValueInfo* info() const { return _info; }

  virtual bool init(int numValues);

  // See comments on the base class
  virtual int numValues() const { return _numValues; }

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

  virtual void removeValues(int index, int numValues);

  // See comments on the base class
  virtual void clear() { _data.clear(); _data.squeeze(); _numValues = 0; }

  virtual GmTrackedValueAccessor* accessor(const GmLogCategory& logger, UnitConverter* conv, 
                                           QString desiredUnit, bool atomic = false);

  // See comments on the base class
  virtual size_t usedMemory() const { return _data.capacity() * sizeof(T); }

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

protected:
  const T* iptr(int index) const { assert(index >= 0 && index < _numValues); return _data.data() + index * _dim; }

  T* iptr(int index) { assert(index >= 0 && index < _numValues); return _data.data() + index * _dim; }

  virtual void initVector(int start, int n);

  // See comments on the base class
  virtual bool isDefValue(int index) const { return !memcmp(value(index), _info->defValue(), _dim * sizeof(double)); }

  // See comments on the base class
  virtual StoredValueType storedValueType(int index) const { Q_UNUSED(index);  return GM_SVT_NUMBER; }

  virtual const double* value(int index) const;
  virtual bool          setValue(int index, const double* values);

  // See comments on the base class. Functions are not supported by this value set
  virtual void* functionValue(int index) const { Q_UNUSED(index); assert(0); return NULL; }

  // See comments on the base class. Functions are not supported by this value set
  virtual bool setFunctionValue(int index, StoredValueType type, void* functionObj) 
  { 
    Q_UNUSED(index); Q_UNUSED(type); Q_UNUSED(functionObj); 
    assert(0);  
    return false; 
  }

  // See comments on the base class
  virtual char* dumpBuffer() { return (char*)_data.data(); }

  // See comments on the base class
  virtual int dumpBufferSize() const { return _data.size() * sizeof(T); }

  GmValueInfo*              _info;       
  int                       _dim;        
  int                       _numValues;  
  QVarLengthArray<T, 1>     _data;       
  GmTLBuffer<double, true>* _convBuffer; 

private:
  Q_DISABLE_COPY(GmVectorValueSetData);
};

//----------------------------------------------------------------------
//  GmFVectorValueSetData - GmVectorValueSetData with support for functions
//----------------------------------------------------------------------

class GmFVectorValueSetData : public GmVectorValueSetData<double>
{
public:
  GmFVectorValueSetData(GmValueInfo* info, GmValueSetEvalContext* evalContext);

  virtual GmTrackedValueAccessor* accessor(const GmLogCategory& logger, UnitConverter* conv, 
                                           QString desiredUnit, bool atomic = false);

protected:
  const GmNanBoxedValue* nanBoxPtr(int index) const { return (const GmNanBoxedValue*)iptr(index); }

  GmNanBoxedValue* nanBoxPtr(int index) { return (GmNanBoxedValue*)iptr(index); }

  virtual void initVector(int start, int n);

  virtual bool isDefValue(int index) const;

  virtual StoredValueType storedValueType(int index) const;

  virtual const double* value   (int index) const;
  virtual bool          setValue(int index, const double* values);

  virtual void* functionValue   (int index) const;
  virtual bool  setFunctionValue(int index, StoredValueType type, void* functionObj);

  GmUserFunction* _defFunction; 

private:
  Q_DISABLE_COPY(GmFVectorValueSetData);
};


//----------------------------------------------------------------------
//  GmDefValueValueSetData - ValueSetData returning always the default value
//----------------------------------------------------------------------

class GMC_API_EXPORT GmDefValueValueSetData : public GmValueSetData
{
public:
  GmDefValueValueSetData(GmValueSetData* baseContainer, GmValueSet* vs);

  virtual ~GmDefValueValueSetData();

  // See comments on the base class
  virtual GmValueInfo* info() const { return _bc->info(); }

  // See comments on the base class
  virtual bool init(int numValues) { _numValues = numValues; return true; }

  // See comments on the base class
  virtual int numValues() const { return _numValues; }

  // See comments on the base class
  virtual bool addValues(int numAddedValues) { _numValues += numAddedValues; return true; }

  // See comments on the base class
  virtual void restoreSize(int oldNumValues) { _numValues = oldNumValues; }

  // See comments on the base class
  virtual void removeValues(int index, int numValues) 
  { 
    Q_UNUSED(index); 
    assert(index >= 0 && index + numValues <= _numValues); 
    _numValues -= numValues; 
  }

  // See comments on the base class
  virtual void clear() { _numValues = 0; }

  virtual GmTrackedValueAccessor* accessor(const GmLogCategory& logger, UnitConverter* conv, 
                                           QString desiredUnit, bool atomic = false);

  // See comments on the base class
  virtual size_t usedMemory() const { return 0; } // This value set uses a constant memory amount, not returned by usedMemory to be consistent with other ValueSetData classes

  static void cleanupDetachedData();

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

protected:
  // See comments on the base class
  virtual bool isDefValue(int index) const { Q_UNUSED(index); return true; }

  // See comments on the base class
  virtual StoredValueType storedValueType(int index) const { Q_UNUSED(index); return _defType; }

  // See comments on the base class
  virtual const double* value(int index) const { Q_UNUSED(index); assert(_defType == GM_SVT_NUMBER); return (double*)_defValue; }

  virtual bool setValue(int index, const double* values);

  // See comments on the base class
  virtual void* functionValue(int index) const { Q_UNUSED(index); assert(_defType != GM_SVT_NUMBER); return _defValue; }

  virtual bool setFunctionValue(int index, StoredValueType type, void* functionObj);

  int             _numValues; 
  GmValueSetData* _bc;        
  GmValueSet*     _vs;        
  StoredValueType _defType;   
  void*           _defValue;  
  QMutex          _setMutex;  
  bool            _detached;  

  static QVector<GmValueSetData*> _detachedList;

private:
  Q_DISABLE_COPY(GmDefValueValueSetData);
};

#endif