src/libengrid/volumedefinition.h

   1 // ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
   2 // +                                                                      +
   3 // + This file is part of enGrid.                                         +
   4 // +                                                                      +
   5 // + Copyright 2008-2014 enGits GmbH                                      +
   6 // +                                                                      +
   7 // + enGrid is free software: you can redistribute it and/or modify       +
   8 // + it under the terms of the GNU General Public License as published by +
   9 // + the Free Software Foundation, either version 3 of the License, or    +
  10 // + (at your option) any later version.                                  +
  11 // +                                                                      +
  12 // + enGrid is distributed in the hope that it will be useful,            +
  13 // + but WITHOUT ANY WARRANTY; without even the implied warranty of       +
  14 // + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        +
  15 // + GNU General Public License for more details.                         +
  16 // +                                                                      +
  17 // + You should have received a copy of the GNU General Public License    +
  18 // + along with enGrid. If not, see <http://www.gnu.org/licenses/>.       +
  19 // +                                                                      +
  20 // ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  21 #ifndef VOLUMEDEFINITION_H
  22 #define VOLUMEDEFINITION_H
  23
  24 #include <QString>
  25 #include <QMap>
  26
  27 class VolumeDefinition
  28 {
  29 private:
  30   QString name;      ///< name of the volume (unique identifier)
  31   int vc;            ///< volume code
  32   QMap<int,int> bcs; ///< maps each BC of the volume to a sign (+1 if the outside is green /-1 if the outside is yellow)
  33
  34 public: // methods
  35
  36   VolumeDefinition();
  37   VolumeDefinition(QString name, int vc);
  38
  39   void setVC(int v) { vc = v; }
  40
  41   QString getName() { return name; } ///< get name
  42   int getVC() { return vc; }         ///< get volume code
  43   void addBC(int bc, int sign);      ///< bcs[bc] = sign;
  44   int getSign(int bc);               ///< returns bcs[bc] if it exists, otherwise returns 0
  45 };
  46
  47 #endif // VOLUMEDEFINITION_H