src/Model/Model_AttributeDouble.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 Model_AttributeDouble_H_
  21 #define Model_AttributeDouble_H_
  22
  23 #include "Model.h"
  24 #include "ModelAPI_AttributeDouble.h"
  25
  26 #include <TDF_Label.hxx>
  27
  28 class ModelAPI_ExpressionDouble;
  29
  30 /**\class Model_AttributeDouble
  31  * \ingroup DataModel
  32  * \brief Attribute that contains real value with double precision.
  33  */
  34
  35 class Model_AttributeDouble : public ModelAPI_AttributeDouble
  36 {
  37   std::shared_ptr<ModelAPI_ExpressionDouble> myExpression;
  38
  39  public:
  40   /// Defines the double value
  41   MODEL_EXPORT virtual void setValue(const double theValue);
  42
  43   /// Returns the double value
  44   MODEL_EXPORT virtual double value();
  45
  46   /// Defines the calculated double value
  47   MODEL_EXPORT virtual void setCalculatedValue(const double theValue);
  48
  49   /// Defines the text value
  50   MODEL_EXPORT virtual void setText(const std::wstring& theText);
  51
  52   /// Returns the text value
  53   MODEL_EXPORT virtual std::wstring text();
  54
  55   /// Allows to set expression (text) as invalid (by the parameters listener)
  56   MODEL_EXPORT virtual void setExpressionInvalid(const bool theFlag);
  57
  58   /// Returns true if text is invalid
  59   MODEL_EXPORT virtual bool expressionInvalid();
  60
  61   /// Allows to set expression (text) error (by the parameters listener)
  62   MODEL_EXPORT virtual void setExpressionError(const std::string& theError);
  63
  64   /// Returns an expression error
  65   MODEL_EXPORT virtual std::string expressionError();
  66
  67   /// Defines the used parameters
  68   MODEL_EXPORT virtual void setUsedParameters(const std::set<std::wstring>& theUsedParameters);
  69
  70   /// Returns the used parameters
  71   MODEL_EXPORT virtual std::set<std::wstring> usedParameters() const;
  72
  73  protected:
  74   /// Initializes attributes
  75   Model_AttributeDouble(TDF_Label& theLabel);
  76   /// Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc)
  77   virtual void reinit();
  78
  79   /// Resets attribute to deafult state.
  80   virtual void reset();
  81
  82   friend class Model_Data;
  83 };
  84
  85 #endif