src/XAO/XAO_Field.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_FIELD_HXX__
  22 #define __XAO_FIELD_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
  37 namespace XAO
  38 {
  39     typedef std::vector<Step*>::iterator stepIterator;
  40
  41     /**
  42      * @class Field
  43      * A geometrical Field.
  44      */
  45     class XAO_EXPORT Field
  46     {
  47     protected:
  48         /**
  49          * Constructor.
  50          * @param dimension the dimension of the field.
  51          * @param nbElements the number of elements.
  52          * @param nbComponents the number of components.
  53          * @param name the name of the field.
  54          */
  55         Field(const XAO::Dimension& dimension,
  56               const int& nbElements, const int& nbComponents, const std::string& name);
  57
  58     public:
  59         /**
  60          * Creates a Field of the given type.
  61          * @param type the type of the field to create.
  62          * @param dimension the dimension.
  63          * @param nbElements the number of geometrical elements.
  64          * @param nbComponents the number of components.
  65          * @name the name of the field.
  66          * @return the created field.
  67          */
  68         static Field* createField(const XAO::Type& type, const XAO::Dimension& dimension,
  69                                   const int& nbElements, const int& nbComponents,
  70                                   const std::string& name = std::string(""))
  71         throw (XAO_Exception);
  72
  73         /**
  74          * Destructor.
  75          */
  76         virtual ~Field();
  77
  78         /**
  79          * Gets the Type of the field.
  80          * @return the Type of the field.
  81          */
  82         virtual const XAO::Type getType() = 0;
  83
  84         /**
  85          * Gets the name of the Field.
  86          * @return the name of the Field.
  87          */
  88         const std::string getName() const
  89         {
  90             return m_name;
  91         }
  92
  93         /**
  94          * Sets the name of the Field.
  95          * @param name the name to set.
  96          */
  97         void setName(const std::string& name)
  98         {
  99             m_name = name;
 100         }
 101
 102         /**
 103          * Gets the Dimension of the Field.
 104          * @return the Dimension of the Field.
 105          */
 106         const XAO::Dimension getDimension() const
 107         {
 108             return m_dimension;
 109         }
 110
 111         /**
 112          * Gets the number of elements of each step.
 113          * @return the number of elements of each step.
 114          */
 115         const int countElements() const
 116         {
 117             return m_nbElements;
 118         }
 119
 120         /**
 121          * Gets the number of components.
 122          * @return the number of components.
 123          */
 124         const int countComponents() const
 125         {
 126             return m_nbComponents;
 127         }
 128
 129         /**
 130          * Gets the number of values for each step.
 131          * @return the number of values for each step.
 132          */
 133         const int countValues() const
 134         {
 135             return m_nbElements * m_nbComponents;
 136         }
 137
 138         /**
 139          * Gets the number of the steps.
 140          * @return the number of steps.
 141          */
 142         const int countSteps() const { return m_steps.size(); }
 143
 144         /**
 145          * Gets the name of a component.
 146          * @param index the index of the component to get.
 147          * @return the name of the component for the given index.
 148          */
 149         const std::string getComponentName(const int& index) throw (XAO_Exception);
 150
 151         /**
 152          * Sets the name of a component.
 153          * @param componentIndex the index of the component to set.
 154          * @param name the name to set.
 155          */
 156         void setComponentName(const int& componentIndex, const std::string& name) throw (XAO_Exception);
 157
 158         /**
 159          * Sets the name of the components.
 160          * @param names the names to set.
 161          */
 162         void setComponentsNames(const std::vector<std::string>& names) throw (XAO_Exception);
 163
 164         /**
 165          * Adds a new step of the same type than the field.
 166          * @param number the numer of the step.
 167          * @return the new create step.
 168          */
 169         virtual Step* addNewStep(const int& number) throw (XAO_Exception) = 0;
 170
 171         /**
 172          * Remove a step.
 173          * @param step the step to remove.
 174          * @return true if the step has been removed, false otherwise.
 175          */
 176         bool removeStep(Step* step);
 177
 178         /**
 179          * Verifies if the field has a step with the given step number.
 180          * @param step the step number.
 181          * @return true if the field has a step for the given number.
 182          */
 183         bool hasStep(const int& step);
 184
 185         /**
 186          * Returns the first step.
 187          * @return an iterator on the first step.
 188          */
 189         stepIterator begin() { return m_steps.begin(); }
 190
 191         /**
 192          * Returns the last step.
 193          * @return an iterator on the last step.
 194          */
 195         stepIterator end() { return m_steps.end(); }
 196
 197     protected:
 198         void checkComponent(const int& component) throw (XAO_Exception);
 199         void checkStepIndex(const int& step) throw (XAO_Exception);
 200
 201     protected:
 202         /** The name of the Field. */
 203         std::string m_name;
 204         /** The dimension of the Field. */
 205         XAO::Dimension m_dimension;
 206
 207         /** The number of components. */
 208         int m_nbComponents;
 209         /** The components of the field. */
 210         std::vector<std::string> m_components;
 211         /** The number of elements. */
 212         int m_nbElements;
 213
 214         /** The list of steps. */
 215         std::vector<Step*> m_steps;
 216     };
 217 }
 218
 219 #endif