GemaCoreLib
The GeMA Core library
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
GmResultAcDataSrcBase Class Referenceabstract

A calss storing basic information about a result data to be exported (monitored / saved), that is common to node, cell and Gauss data sources. More...

#include <gmResultDataSrc.h>

Inheritance diagram for GmResultAcDataSrcBase:
Inheritance graph
[legend]
Collaboration diagram for GmResultAcDataSrcBase:
Collaboration graph
[legend]

Public Member Functions

 GmResultAcDataSrcBase (int trackId)
 Default constructor.
 
virtual ~GmResultAcDataSrcBase ()
 Destructor.
 
virtual int trackId () const
 Returns a numeric id for this data src (a value between 0 and the number of monitored data srcs in the model, or -1 if this data src is not monitored)
 
virtual QString id () const =0
 
virtual QString alias () const
 Returns the data src "exported" id.
 
virtual QString formatStr () const
 How should dataSrc values be formated?
 
virtual bool isScalar () const =0
 Returns true if the accessor value is a scalar value or there is a dimensional filter.
 
virtual int dimSize () const =0
 Returns the accessor valueSize() adjusted by an optional dimension filter.
 
int history () const
 Returns the state accessed by this data src.
 
int dimFilter () const
 Returns the dimension filter value (-1 if there is no filter)
 
void setBasicData (int dim, const QString &alias, int history, GmInterpolatorType interpType, const QVariant &interpParam)
 Sets the values of the given basic object attributes.
 
void setFormatStr (const QString &formatStr)
 Sets the format string.
 
void setTransformationFunction (LuaFunction &tfunc, int nresLin, int nresCol)
 Sets the transformation function along with its result dimensions.
 
void setInterpolator (GmInterpolator *interp)
 Sets the configured interpolator for this data source. Takes ownership of the object.
 
- Public Member Functions inherited from GmResultDataSrcInfo
virtual ~GmResultDataSrcInfo ()
 Virtual destructor.
 
virtual GmResultDataSrcType type () const =0
 Returns the data src type.
 
virtual QString description () const =0
 Returns the data src description, when available.
 
virtual Unit unit () const =0
 Returns the unit in which the data is expressed.
 
virtual int size () const =0
 Returns the dimension of the data src values, taking into account any applied transformations or dim filters. Equal to nlin() * ncol(). A size of zero means that this data src returns string values (valid only for attribute type). A value of -1 means that this object has not been fully initialised yet.
 
virtual int nlin () const =0
 The number of lines in the returned result, taking into account any applied transformations or dim filters. A size of zero means that this data src returns string values (valid only for attribute type). A value of -1 means that this object has not been fully initialised yet.
 
virtual int ncol () const =0
 The number of columns in the returned result, taking into account any applied transformations or dim filters. A size of zero means that this data src returns string values (valid only for attribute type). A value of -1 means that this object has not been fully initialised yet.
 

Protected Member Functions

 Q_DISABLE_COPY (GmResultAcDataSrcBase)
 
 GmResultAcDataSrcBase (const GmResultAcDataSrcBase *ptr)
 A kind of "copy" constructor geting a pointer instead of a reference that copies the contents of the given data src. Does NOT handle interpolators. Needed to enable the GmResultAcDataSrc::dimSplit() implementation. More...
 

Protected Attributes

int _trackId
 The numeric id for this data src (a value between 0 and the number of data srcs in the model)
 
QString _alias
 The name given to the "exported" data. Always filled (might be equal to id())
 
int _dim
 A "bound" dimension for returning a scalar when the data is multidimensional (-1 for returning all values)
 
QString _formatStr
 The format string for the data. Usually equal to the accessor format.
 
int _history
 The state accessed by this data src (0 = current state, 1 = previous, etc..)
 
GmInterpolatorType _interpType
 How do we interpolate data?
 
QVariant _interpParam
 Optional interpolation parameters.
 
LuaFunction _tFunc
 An optional transformation function applied over the data (filtered by _dim) before exporting.
 
int _nResLin
 The number of lines of the result returned by _tFunc.
 
int _nResCol
 The number of columns of the result returned by _tFunc.
 
GmInterpolator_interp
 The configured interpolator object. Can be NULL.
 

Friends

class GmResultsRule
 

Detailed Description

A calss storing basic information about a result data to be exported (monitored / saved), that is common to node, cell and Gauss data sources.

Constructor & Destructor Documentation

◆ GmResultAcDataSrcBase()

GmResultAcDataSrcBase::GmResultAcDataSrcBase ( const GmResultAcDataSrcBase ptr)
inlineprotected

A kind of "copy" constructor geting a pointer instead of a reference that copies the contents of the given data src. Does NOT handle interpolators. Needed to enable the GmResultAcDataSrc::dimSplit() implementation.


The documentation for this class was generated from the following file: