]> SALOME platform Git repositories - modules/shaper.git/blob - src/XAO/XAO_StringField.hxx
Salome HOME
Fixed validators for Boolean and Intersection
[modules/shaper.git] / src / XAO / XAO_StringField.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_STRINGFIELD_HXX__
22 #define __XAO_STRINGFIELD_HXX__
23
24 #include <string>
25
26 #include "XAO.hxx"
27 #include "XAO_XaoUtils.hxx"
28 #include "XAO_Field.hxx"
29 #include "XAO_StringStep.hxx"
30
31 #ifdef WIN32
32 #pragma warning(disable:4290) // Warning Exception ...
33 #endif
34
35 namespace XAO
36 {
37     /**
38      * @class StringField
39      * Represents a field with string values.
40      */
41     class XAO_EXPORT StringField : public Field
42     {
43     public:
44         /**
45          * Constructor.
46          * @param dimension the dimension of the field.
47          * @param nbElements the number of elements.
48          * @param nbComponents the number of components.
49          * @param name the name of the field.
50          */
51         StringField(const XAO::Dimension& dimension, const int& nbElements, const int& nbComponents, const std::string& name);
52
53         virtual const XAO::Type getType() { return XAO::STRING; }
54
55         virtual Step* addNewStep(const int& step) throw (XAO_Exception);
56
57         /**
58          * Adds a new step.
59          * @param step the number of the step.
60          * @return the newly created step.
61          */
62         StringStep* addStep(const int& step) throw (XAO_Exception);
63
64         /**
65          * Adds a new step.
66          * @param step the number of the step.
67          * @param stamp the stamp of the step.
68          * @return the newly created step.
69          */
70         StringStep* addStep(const int& step, const int& stamp) throw (XAO_Exception);
71
72         /**
73          * Gets the step of given index.
74          * @param index the index of the step.
75          * @return the step for the given index.
76          */
77         StringStep* getStep(const int& index) throw (XAO_Exception);
78     };
79 }
80
81 #endif /* __XAO_STRINGFIELD_HXX__ */