gmStateVar.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_STATE_VAR_H_
#define _GEMA_STATE_VAR_H_
 
#include "gmCoreConfig.h"
#include "gmValueInfo.h"
 
#include <QString>
#include <unit.h>
 
class GMC_API_EXPORT GmStateVar
{
public:
  GmStateVar(GmValueInfo* info);
  ~GmStateVar();
 
  const GmValueInfo* info() const { return _info;  }
 
  GmValueInfo* info() { return _info; }
 
  QString id() const { return _info->id(); }
 
  QString description() const { return _info->description();  }
 
  bool isNodeBased() const { return _info->kind() == GM_NODE_STATEVAR; }
 
  bool isCellBased() const { return _info->kind() == GM_CELL_STATEVAR; }
 
  Unit unit() const { return _info->unit();  }
 
  int dim() const { return _info->size(); }
 
  int isScalar() const { return _info->isScalar(); }
 
  int baseDof() const { return _dof; }
 
  int groupId() const { return _groupId; }
 
  QString groupName() const { return _groupName; }
 
  void setBaseDof(int dof) { _dof = dof; }
 
  void setGroupId(QString name, int groupId) { _groupName = name, _groupId = groupId; }
 
  void setGroupId(int groupId) { _groupId = groupId; }
 
  void setGroupName(QString name) { _groupName = name; }
 
private:
 
  GmValueInfo* _info;      
  int          _dof;       
  int          _groupId;   
  QString      _groupName; 
};
 
 
#endif