GmResultsDataSrcInfo Class Reference

A basic interface with the metadata common to all results data src types. This is the information that is broadcasted to monitoring programs and represents each entry in a ResultDataSet. More...

#include <gmResultsDataSrcInfo.h>

Inheritance diagram for GmResultsDataSrcInfo:

Public Member Functions
virtual	~GmResultsDataSrcInfo ()
	Virtual destructor.
virtual int	monitorTrackId () const =0
	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)=0
	Updates the data src's monitor track id.
virtual GmResultsDataSrcType	type () const =0
	Returns the data src type.
virtual QString	alias () const =0
	Returns the data src "exported" id.
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 initialized 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 initialized 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 initialized yet.
virtual QString	formatStr () const =0
	How should dataSrc values be formatted?
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.

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

Detailed Description

A basic interface with the metadata common to all results data src types. This is the information that is broadcasted to monitoring programs and represents each entry in a ResultDataSet.

Member Function Documentation

alias()

virtual QString GmResultsDataSrcInfo::alias ( ) const

pure virtual

Returns the data src "exported" id.

Implemented in GmAcResultsDataSrcBase, GmAttributeResultsDataSrc, and GmAttributeResultsDataSrcInfo.

description()

virtual QString GmResultsDataSrcInfo::description ( ) const

pure virtual

Returns the data src description, when available.

Implemented in GmAcResultsDataSrc< T >, GmAcResultsDataSrc< GmCellAccessor >, GmAcResultsDataSrc< GmGaussAccessor >, GmAcResultsDataSrc< GmValueAccessor >, GmAttributeResultsDataSrc, and GmAttributeResultsDataSrcInfo.

formatStr()

virtual QString GmResultsDataSrcInfo::formatStr ( ) const

pure virtual

How should dataSrc values be formatted?

Implemented in GmAcResultsDataSrcBase, GmAttributeResultsDataSrc, and GmAttributeResultsDataSrcInfo.

monitorTrackId()

virtual int GmResultsDataSrcInfo::monitorTrackId ( ) const

pure virtual

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)

Implemented in GmAcResultsDataSrcBase, GmAttributeResultsDataSrc, and GmAttributeResultsDataSrcInfo.

ncol()

virtual int GmResultsDataSrcInfo::ncol ( ) const

pure virtual

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.

Implemented in GmAcResultsDataSrc< T >, GmAcResultsDataSrc< GmCellAccessor >, GmAcResultsDataSrc< GmGaussAccessor >, GmAcResultsDataSrc< GmValueAccessor >, GmAttributeResultsDataSrc, and GmAttributeResultsDataSrcInfo.

nlin()

virtual int GmResultsDataSrcInfo::nlin ( ) const

pure virtual

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.

Implemented in GmAcResultsDataSrc< T >, GmAcResultsDataSrc< GmCellAccessor >, GmAcResultsDataSrc< GmGaussAccessor >, GmAcResultsDataSrc< GmValueAccessor >, GmAttributeResultsDataSrc, and GmAttributeResultsDataSrcInfo.

setMonitorTrackId()

virtual void GmResultsDataSrcInfo::setMonitorTrackId ( int id )

pure virtual

Updates the data src's monitor track id.

Implemented in GmAcResultsDataSrcBase, GmAttributeResultsDataSrc, and GmAttributeResultsDataSrcInfo.

size()

virtual int GmResultsDataSrcInfo::size ( ) const

pure virtual

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.

Implemented in GmAcResultsDataSrc< T >, GmAcResultsDataSrc< GmCellAccessor >, GmAcResultsDataSrc< GmGaussAccessor >, GmAcResultsDataSrc< GmValueAccessor >, GmAttributeResultsDataSrc, and GmAttributeResultsDataSrcInfo.

type()

virtual GmResultsDataSrcType GmResultsDataSrcInfo::type ( ) const

pure virtual

Returns the data src type.

Implemented in GmAttributeResultsDataSrc, GmAttributeResultsDataSrcInfo, GmCellAcResultsDataSrc, GmGaussAcResultsDataSrc, and GmNodeAcResultsDataSrc.

unit()

virtual Unit GmResultsDataSrcInfo::unit ( ) const

pure virtual

Returns the unit in which the data is expressed.

Implemented in GmAcResultsDataSrc< T >, GmAcResultsDataSrc< GmCellAccessor >, GmAcResultsDataSrc< GmGaussAccessor >, GmAcResultsDataSrc< GmValueAccessor >, GmAttributeResultsDataSrc, and GmAttributeResultsDataSrcInfo.

---

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

• inc/results/gmResultsDataSrcInfo.h
• src/results/gmResultsDataSrcInfo.cpp