GmAttributeResultsDataSrcInfo Class Reference

A basic class used to store meta-data information about result attributes DEFINITIONS. More...

#include <gmAttributeResultsDataSrcInfo.h>

Inheritance diagram for GmAttributeResultsDataSrcInfo:

Collaboration diagram for GmAttributeResultsDataSrcInfo:

Public Member Functions
	GmAttributeResultsDataSrcInfo (QString alias, QString description, Unit unit, int nlin, int ncol, QString format, int stats)
void	updateData (Unit unit, int nlin, int ncol, QString format)
void	updateAlias (QString alias)
	Updates the attribute alias (name)
virtual int	monitorTrackId () const
	Returns an invalid trackId since this object is not a real dataSrc, but the metadata for a data src.
virtual void	setMonitorTrackId (int id)
	No update since this object will always have an id equal to -1.
virtual GmResultsDataSrcType	type () const
	Returns the data src type.
virtual QString	alias () const
	Returns the data src "exported" id.
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 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.
virtual QString	formatStr () const
	How should dataSrc values be formatted?
virtual int	attributeStats () const
	Does this data src saves attribute statistics? A value > 0 defines the kind of stats.
Public Member Functions inherited from GmResultsDataSrcInfo
virtual	~GmResultsDataSrcInfo ()
	Virtual destructor.
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.

Private Attributes
QString	_alias
	The data src alias (exported name)
QString	_description
	The data description.
Unit	_unit
	The data unit.
int	_nlin
	The number of lines in the data (0 for string attributes)
int	_ncol
	The number of lines in the data (0 for string attributes)
QString	_formatStr
	The printf style (without the %) format specifier.
int	_stats
	Does this attribute stores statistics? A value > 0 defines the kind of stats.

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

A basic class used to store meta-data information about result attributes DEFINITIONS.

Member Function Documentation

alias()

virtual QString GmAttributeResultsDataSrcInfo::alias ( ) const

inlinevirtual

Returns the data src "exported" id.

Implements GmResultsDataSrcInfo.

description()

virtual QString GmAttributeResultsDataSrcInfo::description ( ) const

inlinevirtual

Returns the data src description, when available.

Implements GmResultsDataSrcInfo.

formatStr()

virtual QString GmAttributeResultsDataSrcInfo::formatStr ( ) const

inlinevirtual

How should dataSrc values be formatted?

Implements GmResultsDataSrcInfo.

monitorTrackId()

virtual int GmAttributeResultsDataSrcInfo::monitorTrackId ( ) const

inlinevirtual

Returns an invalid trackId since this object is not a real dataSrc, but the metadata for a data src.

Implements GmResultsDataSrcInfo.

ncol()

virtual int GmAttributeResultsDataSrcInfo::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()

virtual int GmAttributeResultsDataSrcInfo::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.

setMonitorTrackId()

virtual void GmAttributeResultsDataSrcInfo::setMonitorTrackId ( int id )

inlinevirtual

No update since this object will always have an id equal to -1.

Implements GmResultsDataSrcInfo.

size()

virtual int GmAttributeResultsDataSrcInfo::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.

type()

virtual GmResultsDataSrcType GmAttributeResultsDataSrcInfo::type ( ) const

inlinevirtual

Returns the data src type.

Implements GmResultsDataSrcInfo.

unit()

virtual Unit GmAttributeResultsDataSrcInfo::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/gmAttributeResultsDataSrcInfo.h