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