Salome HOME
Add copyright header according to request of CEA from 06.06.2017
[modules/shaper.git] / src / Model / Model_AttributeInteger.h
1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
19 //
20
21 #ifndef MODEL_ATTRIBUTEINTEGER_H_
22 #define MODEL_ATTRIBUTEINTEGER_H_
23
24 #include <Model.h>
25 #include <ModelAPI_AttributeInteger.h>
26
27 #include <TDF_Label.hxx>
28
29 class ModelAPI_ExpressionInteger;
30
31 /**\class Model_AttributeInteger
32  * \ingroup DataModel
33  * \brief Attribute that contains integer.
34  */
35
36 class Model_AttributeInteger : public ModelAPI_AttributeInteger
37 {
38  public:
39   /// Defines the integer value
40   MODEL_EXPORT virtual void setValue(const int theValue);
41
42   /// Returns the integer value
43   MODEL_EXPORT virtual int value();
44
45   /// Defines the calculated value
46   MODEL_EXPORT virtual void setCalculatedValue(const int theValue);
47
48   /// Defines the text value
49   MODEL_EXPORT virtual void setText(const std::string& theText);
50
51   /// Returns the text value
52   MODEL_EXPORT virtual std::string text();
53
54   /// Allows to set expression (text) as invalid (by the parameters listener)
55   MODEL_EXPORT virtual void setExpressionInvalid(const bool theFlag);
56
57   /// Returns true if text is invalid
58   MODEL_EXPORT virtual bool expressionInvalid();
59
60   /// Allows to set expression (text) error (by the parameters listener)
61   MODEL_EXPORT virtual void setExpressionError(const std::string& theError);
62
63   /// Returns an expression error
64   MODEL_EXPORT virtual std::string expressionError();
65
66   /// Defines the used parameters
67   MODEL_EXPORT virtual void setUsedParameters(const std::set<std::string>& theUsedParameters);
68
69   /// Returns the used parameters
70   MODEL_EXPORT virtual std::set<std::string> usedParameters() const;
71
72  protected:
73   /// Initializes attributes
74   Model_AttributeInteger(TDF_Label& theLabel);
75   /// Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc)
76   virtual void reinit();
77
78   friend class Model_Data;
79
80  private:
81   std::shared_ptr<ModelAPI_ExpressionInteger> myExpression;
82 };
83
84 #endif