src/XAO/XAO_BooleanField.hxx

   1 // Copyright (C) 2013-2015  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19 // Author : Frederic Pons (OpenCascade)
  20
  21 #ifndef __XAO_BOOLEANFIELD_HXX__
  22 #define __XAO_BOOLEANFIELD_HXX__
  23
  24 #include <string>
  25
  26 #include "XAO.hxx"
  27 #include "XAO_XaoUtils.hxx"
  28 #include "XAO_Field.hxx"
  29 #include "XAO_BooleanStep.hxx"
  30
  31 #ifdef WIN32
  32 #pragma warning(disable:4290) // Warning Exception ...
  33 #endif
  34
  35
  36 namespace XAO
  37 {
  38     /**
  39      * @class BooleanField
  40      * Represents a field with boolean values.
  41      */
  42     class XAO_EXPORT BooleanField : public Field
  43     {
  44     public:
  45         /**
  46          * Constructor.
  47          * @param dimension the dimension of the field.
  48          * @param nbElements the number of elements.
  49          * @param nbComponents the number of components.
  50          * @param name the name of the field.
  51          */
  52         BooleanField(const XAO::Dimension& dimension, const int& nbElements, const int& nbComponents, const std::string& name);
  53
  54         virtual const XAO::Type getType() { return XAO::BOOLEAN; }
  55
  56         virtual Step* addNewStep(const int& step) throw (XAO_Exception);
  57
  58         /**
  59          * Adds a new step.
  60          * @param step the number of the step.
  61          * @return the newly created step.
  62          */
  63         BooleanStep* addStep(const int& step) throw (XAO_Exception);
  64
  65         /**
  66          * Adds a new step.
  67          * @param step the number of the step.
  68          * @param stamp the stamp of the step.
  69          * @return the newly created step.
  70          */
  71         BooleanStep* addStep(const int& step, const int& stamp)
  72         throw (XAO_Exception);
  73
  74         /**
  75          * Gets the step of given index.
  76          * @param index the index.
  77          * @return the step for the given index.
  78          */
  79         BooleanStep* getStep(const int& index) throw (XAO_Exception);
  80     };
  81 }
  82
  83 #endif /* __XAO_BOOLEANFIELD_HXX__ */