]> SALOME platform Git repositories - modules/shaper.git/blob - src/ModelAPI/ModelAPI_AttributeInteger.h
Salome HOME
Issue #2358: Preserve state of folders on move in/out objects to a folder
[modules/shaper.git] / src / ModelAPI / ModelAPI_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 MODELAPI_ATTRIBUTEINTEGER_H_
22 #define MODELAPI_ATTRIBUTEINTEGER_H_
23
24 #include <ModelAPI_Attribute.h>
25
26 #include <set>
27 #include <string>
28
29 /**\class ModelAPI_AttributeInteger
30  * \ingroup DataModel
31  * \brief API for the attribute that contains integer (int).
32  */
33
34 class ModelAPI_AttributeInteger : public ModelAPI_Attribute
35 {
36  public:
37   /// Defines the integer value
38   MODELAPI_EXPORT virtual void setValue(const int theValue) = 0;
39
40   /// Returns the integer value
41   MODELAPI_EXPORT virtual int value() = 0;
42
43   /// Defines the calculated value
44   MODELAPI_EXPORT virtual void setCalculatedValue(const int theValue) = 0;
45
46   /// Defines the text value
47   MODELAPI_EXPORT virtual void setText(const std::string& theText) = 0;
48
49   /// Returns the text value
50   MODELAPI_EXPORT virtual std::string text() = 0;
51
52   /// Allows to set expression (text) as invalid (by the parameters listener)
53   MODELAPI_EXPORT virtual void setExpressionInvalid(const bool theFlag) = 0;
54
55   /// Returns true if text is invalid
56   MODELAPI_EXPORT virtual bool expressionInvalid() = 0;
57
58   /// Allows to set expression (text) error (by the parameters listener)
59   MODELAPI_EXPORT virtual void setExpressionError(const std::string& theError) = 0;
60
61   /// Returns an expression error
62   MODELAPI_EXPORT virtual std::string expressionError() = 0;
63
64   /// Defines the used parameters
65   MODELAPI_EXPORT virtual
66     void setUsedParameters(const std::set<std::string>& theUsedParameters) = 0;
67
68   /// Returns the used parameters
69   MODELAPI_EXPORT virtual std::set<std::string> usedParameters() const = 0;
70
71   /// Returns the type of this class of attributes
72   MODELAPI_EXPORT static std::string typeId()
73   {
74     return "Integer";
75   }
76
77   /// Returns the type of this class of attributes, not static method
78   MODELAPI_EXPORT virtual std::string attributeType();
79
80   /// To virtually destroy the fields of successors
81   MODELAPI_EXPORT virtual ~ModelAPI_AttributeInteger();
82
83  protected:
84   /// Objects are created for features automatically
85   MODELAPI_EXPORT ModelAPI_AttributeInteger();
86 };
87
88 //! Pointer on double attribute
89 typedef std::shared_ptr<ModelAPI_AttributeInteger> AttributeIntegerPtr;
90
91 #endif