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"
 
class GmTrackedValueAccessor;
class UnitConverter;
class GmLogCategory;
 
 
// Enable the define  below to force validation of internal structures after value set initialization or growth
// #define ENABLE_VALUESETDATA_TESTS
 
#define GM_VALUESET_ALIGNED_BUFFERS true
 
//----------------------------------------------------------------------
//  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 isDual() const = 0;
 
  virtual int numValues() const = 0;
 
  virtual int storedItemSize() const = 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  below 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 being used by users of ValueSetData, who should always access and store
  // values through accessors.  Some of them are also necessary by the state dump and HDF5 classes.
  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 GmDefValueValueSetStoredData;
  friend class GmStateDumpValueSetDataItem;
  friend class GmHdf5ModelWriter;
 
  virtual bool isDefValue(int index) const = 0;
 
  virtual bool allValuesAreDef() const;
 
  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;
};
 
 
#endif