src/XAO/XAO_DoubleStep.hxx

   1 // Copyright (C) 2013-2019  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_DOUBLESTEP_HXX__
  22 #define __XAO_DOUBLESTEP_HXX__
  23
  24 #include <vector>
  25
  26 #include "XAO.hxx"
  27 #include "XAO_XaoUtils.hxx"
  28 #include "XAO_Step.hxx"
  29
  30 #ifdef WIN32
  31 #pragma warning(disable:4290) // Warning Exception ...
  32 #endif
  33
  34
  35 namespace XAO
  36 {
  37     /**
  38      * @class DoubleStep
  39      * Step with double values.
  40      */
  41     class XAO_EXPORT DoubleStep : public Step
  42     {
  43     public:
  44         /**
  45          * Constructor.
  46          * @param step the step number.
  47          * @param stamp the stamp of the step.
  48          * @param nbElements the number elements of the geometry.
  49          * @param nbComponents the number of components of the field.
  50          */
  51         DoubleStep(const int& step, const int& stamp, const int& nbElements, const int& nbComponents);
  52
  53         virtual const XAO::Type getType() { return XAO::DOUBLE; }
  54
  55         /**
  56          * Gets all the values of the step as a list.
  57          * @return a vector containing all the values of the step.
  58          */
  59         std::vector<double> getValues();
  60
  61         /**
  62          * Gets all the values for a given element.
  63          * @param element the index of the element.
  64          * @return a vector containing all the values for the given element.
  65          */
  66         std::vector<double> getElement(const int& element) throw (XAO_Exception);
  67
  68         /**
  69          * Gets all the values for a given component.
  70          * @param component the index of the component.
  71          * @return a vector containing all the values for the given component.
  72          */
  73         std::vector<double> getComponent(const int& component) throw (XAO_Exception);
  74
  75         /**
  76          * Gets the value for an element and a component.
  77          * @param element the index of the element.
  78          * @param component the index of the component.
  79          * @return the value for the given element and component.
  80          */
  81         const double getValue(const int& element, const int& component) throw (XAO_Exception);
  82
  83         /**
  84          * Sets all the values from a list.
  85          * @param values the list of values to set.
  86          */
  87         void setValues(const std::vector<double>& values) throw (XAO_Exception);
  88
  89         /**
  90          * Sets the values for an element.
  91          * @param element the index of the element to set.
  92          * @param elements the values to set.
  93          */
  94         void setElement(const int& element, const std::vector<double>& elements) throw (XAO_Exception);
  95
  96         /**
  97          * Sets the values for a component.
  98          * @param component the index of the component to set.
  99          * @param components the values to set.
 100          */
 101         void setComponent(const int& component, const std::vector<double>& components) throw (XAO_Exception);
 102
 103         /**
 104          * Sets the value for an element and a component.
 105          * @param element the index of the element.
 106          * @param component the index of the component.
 107          * @param value the value.
 108          */
 109         void setValue(const int& element, const int& component, const double& value) throw (XAO_Exception);
 110
 111         virtual const std::string getStringValue(const int& element, const int& component) throw (XAO_Exception);
 112         virtual void setStringValue(const int& element, const int& component, const std::string& value) throw (XAO_Exception);
 113
 114     private:
 115         std::vector< std::vector<double> > m_values;
 116     };
 117 }
 118
 119
 120 #endif /* __XAO_DOUBLESTEP_HXX__ */