src/XAO/XAO_IntegerField.hxx

   1 // Copyright (C) 2013  CEA/DEN, EDF R&D
   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.
   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_INTEGERFIELD_HXX__
  22 #define __XAO_INTEGERFIELD_HXX__
  23
  24 #include <string>
  25
  26 #include "XAO_XaoUtils.hxx"
  27 #include "XAO_Field.hxx"
  28 #include "XAO_IntegerStep.hxx"
  29
  30 namespace XAO
  31 {
  32     /**
  33      * @class IntegerField
  34      * Represents a field with integer values.
  35      */
  36     class IntegerField : public Field
  37     {
  38     public:
  39         /**
  40          * Constructor.
  41          * @param dimension the dimension of the field.
  42          * @param nbElements the number of elements.
  43          * @param nbComponents the number of components.
  44          * @param name the name of the field.
  45          */
  46         IntegerField(const XAO::Dimension& dimension, const int& nbElements, const int& nbComponents, const std::string& name);
  47
  48         virtual const XAO::Type getType() { return XAO::INTEGER; }
  49
  50         virtual Step* addNewStep(const int& step) throw (XAO_Exception);
  51
  52         /**
  53          * Adds a new step.
  54          * @param step the number of the step.
  55          * @return the newly created step.
  56          */
  57         IntegerStep* addStep(const int& step) throw (XAO_Exception);
  58
  59         /**
  60          * Adds a new step.
  61          * @param step the number of the step.
  62          * @param stamp the stamp of the step.
  63          * @return the newly created step.
  64          */
  65         IntegerStep* addStep(const int& step, const int& stamp) throw (XAO_Exception);
  66
  67         /**
  68          * Gets the step of given index.
  69          * @param index the index of the step.
  70          * @return the step for the given index.
  71          */
  72         IntegerStep* getStep(const int& index) throw (XAO_Exception);
  73     };
  74 }
  75
  76 #endif /* __XAO_INTEGERFIELD_HXX__ */