Aux class adding an accessor to a basic result data source. More...

#include <gmAcResultsDataSrc.h>

Inheritance diagram for GmAcResultsDataSrc< T >:

[legend]

Collaboration diagram for GmAcResultsDataSrc< T >:

[legend]

Public Types
typedef T	AcType

Public Member Functions
	GmAcResultsDataSrc (T *ac)
	Constructor.

virtual	~GmAcResultsDataSrc ()
	Destructor.

virtual QString	id () const

virtual QString	description () const
	Returns the data src description, when available.

virtual Unit	unit () const
	Returns the unit in which the data is expressed.

virtual bool	isScalar () const
	Returns true if the accessor value is a scalar value or there is a dimensional filter.

virtual int	dimSize () const
	Returns the accessor valueSize() adjusted by an optional dimension filter.

virtual int	size () const
	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 initialized yet.

virtual int	nlin () const
	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 initialized yet.

virtual int	ncol () const
	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 initialized yet.

T *	ac () const
	Returns the associated accessor.

void	setAc (T *newAc)
	Updates the stored accessor, taking ownership of it. Used by GmFileIO for replacing an accessor by another one for the same data but different state.

Public Member Functions inherited from GmAcResultsDataSrcBase
	GmAcResultsDataSrcBase ()
	Default constructor.

virtual	~GmAcResultsDataSrcBase ()
	Destructor.

virtual int	monitorTrackId () const
	Returns a numeric id for this data src (a value between 0 and the number of monitored data sources in the model, or -1 if this data src is not monitored)

virtual void	setMonitorTrackId (int id)
	Updates the data src's monitor track id.

virtual QString	alias () const
	Returns the data src "exported" id.

virtual QString	formatStr () const
	How should dataSrc values be formatted?

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)

GmInterpolator *	interp () const
	Returns the associated interpolator, if any.

bool	hasTransformationFunction () const
	Returns true if this data src is associated with a transfromation function.

GmInterpolatorSubset	subsetType () const

void	setBasicData (int dim, const QString &alias, int history, GmInterpolatorType interpType, const QVariant &interpParam, GmInterpolatorSubset subset)
	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.

bool	interpAcceptDiscSet () const

Public Member Functions inherited from GmResultsDataSrcInfo
virtual	~GmResultsDataSrcInfo ()
	Virtual destructor.

virtual GmResultsDataSrcType	type () const =0
	Returns the data src type.

QString	formatedNumericDataSrcValue (const double *v, QString err) const
	Returns the numeric result value in v formated as a string, according to the current format. If v is NULL, will either return "NA" or "ERROR" if err is not empty.

Protected Member Functions
template<class Result >
QVector< Result * >	dimSplit ()
	Returns a vector with as many data srcs as dimensions. The first one will be the original data src with its dimension filter set to 0. The remaining will be copies, SHARING the SAME accessor (without ownership), and pointing to the other dimensions. Returns a vector with the current src unchanged if this data src already points to a scalar result. The template parameter defines the type of the (derived) copied data srcs.

	GmAcResultsDataSrc (const GmAcResultsDataSrc< T > *ptr)
	A private "copy" constructor geting a pointer instead of a reference that copies the contents of the given data src. The Ac is shared with the original pointer (that retains its ownership). Does NOT handle interpolators. Any interpoltor present on ptr will be discarded from the new object.

Protected Member Functions inherited from GmAcResultsDataSrcBase
	Q_DISABLE_COPY (GmAcResultsDataSrcBase)

	GmAcResultsDataSrcBase (const GmAcResultsDataSrcBase *ptr)
	A kind of "copy" constructor geting a pointer instead of a reference that copies the contents of the given data src.

Protected Attributes
T *	_ac
	The node data accessor.

bool	_ownership
	Are we the owner of _ac? This can be false as a result of the dimSplit() operation.

Protected Attributes inherited from GmAcResultsDataSrcBase
int	_trackId
	The numeric id for this data src (a value between 0 and the number of monitored data srcs in the model, or -1 if unmonitored)

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.

GmInterpolatorSubset	_subset
	The subset of data to be considered when interpolating discontinuous elements.

Additional Inherited Members
Static Public Member Functions inherited from GmResultsDataSrcInfo
static QString	formatedNumericDataSrcValue (QString fmt, const double *v, int size)
	Returns the numeric result value in v string formated.

Detailed Description

template<class T>
class GmAcResultsDataSrc< T >

Aux class adding an accessor to a basic result data source.

Member Function Documentation

◆ description()

template<class T >

virtual QString GmAcResultsDataSrc< T >::description ( ) const

inlinevirtual

Returns the data src description, when available.

Implements GmResultsDataSrcInfo.

◆ dimSize()

template<class T >

virtual int GmAcResultsDataSrc< T >::dimSize ( ) const

inlinevirtual

Returns the accessor valueSize() adjusted by an optional dimension filter.

Implements GmAcResultsDataSrcBase.

◆ dimSplit()

template<class T >

template<class Result >

QVector< Result * > GmAcResultsDataSrc< T >::dimSplit ( )

inlineprotected

Returns a vector with as many data srcs as dimensions. The first one will be the original data src with its dimension filter set to 0. The remaining will be copies, SHARING the SAME accessor (without ownership), and pointing to the other dimensions. Returns a vector with the current src unchanged if this data src already points to a scalar result. The template parameter defines the type of the (derived) copied data srcs.

TODO: The present implementation can NOT be used with results that include interpolators!

◆ id()

template<class T >

virtual QString GmAcResultsDataSrc< T >::id ( ) const

inlinevirtual

Implements GmAcResultsDataSrcBase.

◆ isScalar()

template<class T >

virtual bool GmAcResultsDataSrc< T >::isScalar ( ) const

inlinevirtual

Returns true if the accessor value is a scalar value or there is a dimensional filter.

Implements GmAcResultsDataSrcBase.

◆ ncol()

template<class T >

virtual int GmAcResultsDataSrc< T >::ncol ( ) const

inlinevirtual

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 initialized yet.

Implements GmResultsDataSrcInfo.

◆ nlin()

template<class T >

virtual int GmAcResultsDataSrc< T >::nlin ( ) const

inlinevirtual

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 initialized yet.

Implements GmResultsDataSrcInfo.

◆ size()

template<class T >

virtual int GmAcResultsDataSrc< T >::size ( ) const

inlinevirtual

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 initialized yet.

Implements GmResultsDataSrcInfo.

◆ unit()

template<class T >

virtual Unit GmAcResultsDataSrc< T >::unit ( ) const

inlinevirtual

Returns the unit in which the data is expressed.

Implements GmResultsDataSrcInfo.

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

inc/results/gmAcResultsDataSrc.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ description()

◆ dimSize()

◆ dimSplit()

◆ id()

◆ isScalar()

◆ ncol()

◆ nlin()

◆ size()

◆ unit()