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