1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ModelAPI_Expression.h
5 // Author: Sergey POKHODENKO
7 #ifndef ModelAPI_Expression_H_
8 #define ModelAPI_Expression_H_
16 /**\class ModelAPI_Expression
18 * \brief Expression for calculated values.
20 class ModelAPI_Expression
23 /// To virtually destroy the fields of successors
24 MODELAPI_EXPORT virtual ~ModelAPI_Expression();
26 /// Returns true if attribute was initialized by some value
27 MODELAPI_EXPORT virtual bool isInitialized();
29 /// Makes attribute initialized
30 MODELAPI_EXPORT virtual void setInitialized();
32 /// Sets the text of this Expression
33 MODELAPI_EXPORT virtual void setText(const std::string& theText) = 0;
35 /// Returns the text of this Expression
36 MODELAPI_EXPORT virtual std::string text() const = 0;
38 /// Allows to set expression (text) as invalid (by the parameters listener)
39 MODELAPI_EXPORT virtual void setInvalid(const bool theFlag) = 0;
41 /// Returns true if text is invalid
42 MODELAPI_EXPORT virtual bool isInvalid() = 0;
44 /// Allows to set expression (text) error (by the parameters listener)
45 MODELAPI_EXPORT virtual void setError(const std::string& theError) = 0;
47 /// Returns an expression error
48 MODELAPI_EXPORT virtual std::string error() = 0;
50 /// Defines the used parameters (by the parameters listener)
51 MODELAPI_EXPORT virtual void setUsedParameters(const std::set<std::string>& theUsedParameters) = 0;
53 /// Returns the used parameters
54 MODELAPI_EXPORT virtual std::set<std::string> usedParameters() const = 0;
56 /// Returns True if the given string can be defined as a name of an expression variable
57 MODELAPI_EXPORT static bool isVariable(const std::string& theString);
60 /// Objects are created for features automatically
61 MODELAPI_EXPORT ModelAPI_Expression();
62 /// Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc)
63 MODELAPI_EXPORT virtual void reinit() = 0;
65 bool myIsInitialized; ///< is some value assigned to this attribute
67 friend class Model_Data;
68 friend class Model_AttributeDouble;
69 friend class Model_AttributeInteger;
70 friend class GeomData_Point;
71 friend class GeomData_Point2D;
75 /**\class ModelAPI_ExpressionDouble
77 * \brief Expression for calculated double values.
79 class ModelAPI_ExpressionDouble : public virtual ModelAPI_Expression
82 /// Defines the double value
83 MODELAPI_EXPORT virtual void setValue(const double theValue) = 0;
85 /// Returns the double value
86 MODELAPI_EXPORT virtual double value() = 0;
89 /// Objects are created for features automatically
90 MODELAPI_EXPORT ModelAPI_ExpressionDouble();
92 friend class Model_Data;
96 /**\class ModelAPI_ExpressionInteger
98 * \brief Expression for calculated integer values.
100 class ModelAPI_ExpressionInteger : public virtual ModelAPI_Expression
103 /// Defines the integer value
104 MODELAPI_EXPORT virtual void setValue(const int theValue) = 0;
106 /// Returns the integer value
107 MODELAPI_EXPORT virtual int value() = 0;
110 /// Objects are created for features automatically
111 MODELAPI_EXPORT ModelAPI_ExpressionInteger();
113 friend class Model_Data;
117 //! Smart pointers for objects
118 typedef std::shared_ptr<ModelAPI_Expression> ExpressionPtr;
119 typedef std::shared_ptr<ModelAPI_ExpressionDouble> ExpressionDoublePtr;
120 typedef std::shared_ptr<ModelAPI_ExpressionInteger> ExpressionIntegerPtr;