GemaCoreLib
The GeMA Core library
Loading...
Searching...
No Matches
gmResultsDataSrcInfo.h
Go to the documentation of this file.
1/************************************************************************
2**
3** Copyright (C) 2014 by Carlos Augusto Teixera Mendes
4** All rights reserved.
5**
6** This file is part of the "GeMA" software. It's use should respect
7** the terms in the license agreement that can be found together
8** with this source code.
9** It is provided AS IS, with NO WARRANTY OF ANY KIND,
10** INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR
11** A PARTICULAR PURPOSE.
12**
13************************************************************************/
14
24#ifndef _GEMA_RESULTS_DATASRC_INFO_H_
25#define _GEMA_RESULTS_DATASRC_INFO_H_
26
27#include "gmCoreConfig.h"
28
29#include <unit.h>
30#include <QString>
31
38
39 // -- Don't add entries below this line --
40 // Also keep in mind that changing the above order can NOT be done lightly
41 // (see GmResultsRule::loadFromTable())
43};
44
50{
51public:
54
59 virtual int monitorTrackId() const = 0;
60
62 virtual void setMonitorTrackId(int id) = 0;
63
65 virtual GmResultsDataSrcType type() const = 0;
66
68 virtual QString alias() const = 0;
69
71 virtual QString description() const = 0;
72
74 virtual Unit unit() const = 0;
75
81 virtual int size() const = 0;
82
88 virtual int nlin() const = 0;
89
95 virtual int ncol() const = 0;
96
98 virtual QString formatStr() const = 0;
99
100 QString formatedNumericDataSrcValue(const double* v, QString err) const;
101
102 static QString formatedNumericDataSrcValue(QString fmt, const double* v, int size);
103};
104
105
106#endif
107
A basic interface with the metadata common to all results data src types. This is the information tha...
Definition gmResultsDataSrcInfo.h:50
virtual QString description() const =0
Returns the data src description, when available.
virtual int ncol() const =0
The number of columns in the returned result, taking into account any applied transformations or dim ...
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...
virtual GmResultsDataSrcType type() const =0
Returns the data src type.
virtual Unit unit() const =0
Returns the unit in which the data is expressed.
virtual QString alias() const =0
Returns the data src "exported" id.
virtual int nlin() const =0
The number of lines in the returned result, taking into account any applied transformations or dim fi...
virtual int size() const =0
Returns the dimension of the data src values, taking into account any applied transformations or dim ...
virtual void setMonitorTrackId(int id)=0
Updates the data src's monitor track id.
virtual ~GmResultsDataSrcInfo()
Virtual destructor.
Definition gmResultsDataSrcInfo.h:53
virtual QString formatStr() const =0
How should dataSrc values be formatted?
Declaration of useful configuration definitions for the Core library.
#define GMC_API_EXPORT
Macro for controlling if the class is being exported (GEMA_CORE_LIB defined) or imported (GEMA_CORE_L...
Definition gmCoreConfig.h:35
GmResultsDataSrcType
The types of data sources stored by a rule.
Definition gmResultsDataSrcInfo.h:33
@ GM_RR_DS_GAUSSDATA
Gauss attributes.
Definition gmResultsDataSrcInfo.h:37
@ GM_RR_DS_NUMTYPES
The number of data src types above.
Definition gmResultsDataSrcInfo.h:42
@ GM_RR_DS_ATTRIBUTE
Attribute data.
Definition gmResultsDataSrcInfo.h:34
@ GM_RR_DS_NODEDATA
Node attributes + State vars.
Definition gmResultsDataSrcInfo.h:35
@ GM_RR_DS_CELLDATA
Cell attributes + properties.
Definition gmResultsDataSrcInfo.h:36