src/Model/Model_AttributeInteger.h

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