]> SALOME platform Git repositories - modules/shaper.git/blob - src/ModelAPI/ModelAPI_AttributeDouble.h
Salome HOME
Issue #2052: Modification of parameters don't work (sketch, extrusion)
[modules/shaper.git] / src / ModelAPI / ModelAPI_AttributeDouble.h
1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
2
3 // File:        ModelAPI_AttributeDouble.h
4 // Created:     2 Apr 2014
5 // Author:      Mikhail PONIKAROV
6
7 #ifndef ModelAPI_AttributeDouble_H_
8 #define ModelAPI_AttributeDouble_H_
9
10 #include <ModelAPI_Attribute.h>
11
12 #include <set>
13 #include <string>
14
15 /**\class ModelAPI_AttributeDouble
16  * \ingroup DataModel
17  * \brief Attribute that contains real value with double precision.
18  */
19
20 class ModelAPI_AttributeDouble : public ModelAPI_Attribute
21 {
22  public:
23   /// Defines the double value
24   MODELAPI_EXPORT virtual void setValue(const double theValue) = 0;
25
26   /// Returns the double value
27   MODELAPI_EXPORT virtual double value() = 0;
28
29   /// Defines the calculated double value
30   MODELAPI_EXPORT virtual void setCalculatedValue(const double theValue) = 0;
31
32   /// Defines the text value
33   MODELAPI_EXPORT virtual void setText(const std::string& theText) = 0;
34
35   /// Returns the text value
36   MODELAPI_EXPORT virtual std::string text() = 0;
37
38   /// Allows to set expression (text) as invalid (by the parameters listener)
39   MODELAPI_EXPORT virtual void setExpressionInvalid(const bool theFlag) = 0;
40
41   /// Returns true if text is invalid
42   MODELAPI_EXPORT virtual bool expressionInvalid() = 0;
43
44   /// Allows to set expression (text) error (by the parameters listener)
45   MODELAPI_EXPORT virtual void setExpressionError(const std::string& theError) = 0;
46
47   /// Returns an expression error
48   MODELAPI_EXPORT virtual std::string expressionError() = 0;
49
50   /// Defines the used parameters
51   MODELAPI_EXPORT virtual
52     void setUsedParameters(const std::set<std::string>& theUsedParameters) = 0;
53
54   /// Returns the used parameters
55   MODELAPI_EXPORT virtual std::set<std::string> usedParameters() const = 0;
56
57   /// Returns the type of this class of attributes
58   MODELAPI_EXPORT static std::string typeId()
59   {
60     return "Double";
61   }
62
63   /// Returns the type of this class of attributes, not static method
64   MODELAPI_EXPORT virtual std::string attributeType();
65
66   /// To virtually destroy the fields of successors
67   MODELAPI_EXPORT virtual ~ModelAPI_AttributeDouble();
68
69  protected:
70   /// Objects are created for features automatically
71   MODELAPI_EXPORT ModelAPI_AttributeDouble();
72 };
73
74 //! Pointer on double attribute
75 typedef std::shared_ptr<ModelAPI_AttributeDouble> AttributeDoublePtr;
76
77 #endif