gmResultDataSrcInfo.h

Go to the documentation of this file.

/************************************************************************
**
** Copyright (C) 2014 by Carlos Augusto Teixera Mendes
** All rights reserved.
**
** This file is part of the "GeMA" software. It's use should respect
** the terms in the license agreement that can be found together 
** with this source code.
** It is provided AS IS, with NO WARRANTY OF ANY KIND, 
** INCLUDING THE WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR 
** A PARTICULAR PURPOSE.
**
************************************************************************/

#ifndef _GEMA_RESULT_DATASRC_INFO_H_
#define _GEMA_RESULT_DATASRC_INFO_H_

#include "gmCoreConfig.h"

#include <unit.h>
#include <QString>

enum GmResultDataSrcType {
  GM_RR_DS_ATTRIBUTE,  
  GM_RR_DS_NODEDATA,   
  GM_RR_DS_CELLDATA,   
  GM_RR_DS_GAUSSDATA,  

  // -- Don't add entries below this line --
  // Also keep in mind that changing the above order can NOT be done lightly 
  // (see GmResultsRule::loadFromTable())
  GM_RR_DS_NUMTYPES,   
};

class GMC_API_EXPORT GmResultDataSrcInfo
{
public:
  virtual ~GmResultDataSrcInfo() {}

  virtual int trackId() const = 0;

  virtual GmResultDataSrcType type() const = 0;

  virtual QString alias() const = 0;

  virtual QString description() const = 0;

  virtual Unit unit() const = 0;

  virtual int size() const = 0;

  virtual int nlin() const = 0;

  virtual int ncol() const = 0;

  virtual QString formatStr() const = 0;
};

class GMC_API_EXPORT GmAttributeResultDataSrcInfo : public GmResultDataSrcInfo
{
public:
  GmAttributeResultDataSrcInfo(GmResultDataSrcType type, QString alias, QString description,
                               Unit unit, int nlin, int ncol, QString format)
    : _type(type), _alias(alias), _description(description), _unit(unit),
      _nlin(nlin), _ncol(ncol), _formatStr(format) {}

  void updateData(Unit unit, int nlin, int ncol, QString format)
  {
    _unit = unit;
    _nlin = nlin;
    _ncol = ncol;
    _formatStr = format;
  }

  virtual int trackId() const { return -1; }

  virtual GmResultDataSrcType type()        const { return _type;  }
  virtual QString             alias()       const { return _alias; }
  virtual QString             description() const { return _description; }
  virtual Unit                unit()        const { return _unit; }
  virtual int                 size()        const { return _nlin * _ncol; }
  virtual int                 nlin()        const { return _nlin; }
  virtual int                 ncol()        const { return _ncol; }
  virtual QString             formatStr()   const { return _formatStr; }

private:
  GmResultDataSrcType _type;        
  QString             _alias;       
  QString             _description; 
  Unit                _unit;        
  int                 _nlin;        
  int                 _ncol;        
  QString             _formatStr;   
};


#endif