src/ModelAPI/ModelAPI_Expression.h

   1 // Copyright (C) 2014-2023  CEA, EDF
   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
  20 #ifndef ModelAPI_Expression_H_
  21 #define ModelAPI_Expression_H_
  22
  23 #include "ModelAPI.h"
  24
  25 #include <memory>
  26 #include <set>
  27 #include <string>
  28
  29 /**\class ModelAPI_Expression
  30  * \ingroup DataModel
  31  * \brief Expression for calculated values.
  32  */
  33 class ModelAPI_Expression
  34 {
  35  public:
  36   /// To virtually destroy the fields of successors
  37   MODELAPI_EXPORT virtual ~ModelAPI_Expression();
  38
  39   /// Returns true if attribute was initialized by some value
  40   MODELAPI_EXPORT virtual bool isInitialized();
  41
  42   /// Makes attribute initialized
  43   MODELAPI_EXPORT virtual void setInitialized();
  44
  45   /// Sets the text of this Expression
  46   MODELAPI_EXPORT virtual void setText(const std::wstring& theText) = 0;
  47
  48   /// Returns the text of this Expression
  49   MODELAPI_EXPORT virtual std::wstring text() const = 0;
  50
  51   /// Allows to set expression (text) as invalid (by the parameters listener)
  52   MODELAPI_EXPORT virtual void setInvalid(const bool theFlag) = 0;
  53
  54   /// Returns true if text is invalid
  55   MODELAPI_EXPORT virtual bool isInvalid() = 0;
  56
  57   /// Allows to set expression (text) error (by the parameters listener)
  58   MODELAPI_EXPORT virtual void setError(const std::string& theError) = 0;
  59
  60   /// Returns an expression error
  61   MODELAPI_EXPORT virtual std::string error() = 0;
  62
  63   /// Defines the used parameters (by the parameters listener)
  64   MODELAPI_EXPORT virtual
  65     void setUsedParameters(const std::set<std::wstring>& theUsedParameters) = 0;
  66
  67   /// Returns the used parameters
  68   MODELAPI_EXPORT virtual std::set<std::wstring> usedParameters() const = 0;
  69
  70   /// Returns True if the given string can be defined as a name of an expression variable
  71   MODELAPI_EXPORT static bool isVariable(const std::string& theString);
  72
  73   /// Returns True if the given string can be defined as a name of an expression variable
  74   MODELAPI_EXPORT static bool isVariable(const std::wstring& theString);
  75
  76  protected:
  77   /// Objects are created for features automatically
  78   MODELAPI_EXPORT ModelAPI_Expression();
  79   /// Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc)
  80   MODELAPI_EXPORT virtual void reinit() = 0;
  81   /// Resets attribute to deafult state.
  82   MODELAPI_EXPORT virtual void reset() {
  83     myIsInitialized = false;
  84   };
  85
  86   bool myIsInitialized; ///< is some value assigned to this attribute
  87
  88   friend class Model_Data;
  89   friend class Model_AttributeDouble;
  90   friend class Model_AttributeInteger;
  91   friend class GeomData_Point;
  92   friend class GeomData_Point2D;
  93 };
  94
  95
  96 /**\class ModelAPI_ExpressionDouble
  97  * \ingroup DataModel
  98  * \brief Expression for calculated double values.
  99  */
 100 class ModelAPI_ExpressionDouble : public virtual ModelAPI_Expression
 101 {
 102  public:
 103   /// Defines the double value
 104   MODELAPI_EXPORT virtual void setValue(const double theValue) = 0;
 105
 106   /// Returns the double value
 107   MODELAPI_EXPORT virtual double value() = 0;
 108
 109  protected:
 110   /// Objects are created for features automatically
 111   MODELAPI_EXPORT ModelAPI_ExpressionDouble();
 112
 113   friend class Model_Data;
 114 };
 115
 116
 117 /**\class ModelAPI_ExpressionInteger
 118  * \ingroup DataModel
 119  * \brief Expression for calculated integer values.
 120  */
 121 class ModelAPI_ExpressionInteger : public virtual ModelAPI_Expression
 122 {
 123  public:
 124   /// Defines the integer value
 125   MODELAPI_EXPORT virtual void setValue(const int theValue) = 0;
 126
 127   /// Returns the integer value
 128   MODELAPI_EXPORT virtual int value() = 0;
 129
 130  protected:
 131   /// Objects are created for features automatically
 132   MODELAPI_EXPORT ModelAPI_ExpressionInteger();
 133
 134   friend class Model_Data;
 135 };
 136
 137
 138 //! Smart pointers for objects
 139 typedef std::shared_ptr<ModelAPI_Expression> ExpressionPtr;
 140 typedef std::shared_ptr<ModelAPI_ExpressionDouble> ExpressionDoublePtr;
 141 typedef std::shared_ptr<ModelAPI_ExpressionInteger> ExpressionIntegerPtr;
 142
 143 #endif