src/libengrid/volumedefinition.h

   1 //
   2 // ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
   3 // +                                                                      +
   4 // + This file is part of enGrid.                                         +
   5 // +                                                                      +
   6 // + Copyright 2008-2012 enGits GmbH                                     +
   7 // +                                                                      +
   8 // + enGrid is free software: you can redistribute it and/or modify       +
   9 // + it under the terms of the GNU General Public License as published by +
  10 // + the Free Software Foundation, either version 3 of the License, or    +
  11 // + (at your option) any later version.                                  +
  12 // +                                                                      +
  13 // + enGrid is distributed in the hope that it will be useful,            +
  14 // + but WITHOUT ANY WARRANTY; without even the implied warranty of       +
  15 // + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        +
  16 // + GNU General Public License for more details.                         +
  17 // +                                                                      +
  18 // + You should have received a copy of the GNU General Public License    +
  19 // + along with enGrid. If not, see <http://www.gnu.org/licenses/>.       +
  20 // +                                                                      +
  21 // ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  22 //
  23 #ifndef VOLUMEDEFINITION_H
  24 #define VOLUMEDEFINITION_H
  25
  26 #include <QString>
  27 #include <QMap>
  28
  29 class VolumeDefinition
  30 {
  31 private:
  32   QString name; ///< name of the volume (unique identifier)
  33   int vc; ///< volume code
  34   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)
  35
  36 public: // methods
  37
  38   VolumeDefinition(); ///< Default constructor
  39   VolumeDefinition(QString name, int vc); ///< Constructor
  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