Salome HOME
f7c89ffb91cf27408e5cb6c6b415fbebb62fe82e
[modules/geom.git] / src / XAO / XAO_DoubleField.hxx
1 // Copyright (C) 2013-2023  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_DOUBLEFIELD_HXX__
22 #define __XAO_DOUBLEFIELD_HXX__
23
24 #include <string>
25
26 #include "XAO.hxx"
27 #include "XAO_XaoUtils.hxx"
28 #include "XAO_Field.hxx"
29 #include "XAO_DoubleStep.hxx"
30
31 #ifdef WIN32
32 #pragma warning(disable:4290) // Warning Exception ...
33 #endif
34
35
36 namespace XAO
37 {
38     /**
39      * @class DoubleField
40      * Represents a field with double values.
41      */
42     class XAO_EXPORT DoubleField : 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         DoubleField(XAO::Dimension dimension, int nbElements, int nbComponents, const std::string& name);
53
54         virtual XAO::Type getType() { return XAO::DOUBLE; }
55
56         virtual Step* addNewStep(int step) ;
57
58         /**
59          * Adds a new step.
60          * @param step the number of the step.
61          * @return the newly created step.
62          */
63         DoubleStep* addStep(int step) ;
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         DoubleStep* addStep(int step, int stamp) ;
72
73         /**
74          * Gets the step of given index.
75          * @param index the index.
76          * @return the step for the given index.
77          */
78         DoubleStep* getStep(int index) ;
79     };
80 }
81
82 #endif /* __XAO_DOUBLEFIELD_HXX__ */