src/ModelAPI/ModelAPI_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 MODELAPI_ATTRIBUTEINTEGER_H_
  21 #define MODELAPI_ATTRIBUTEINTEGER_H_
  22
  23 #include <ModelAPI_Attribute.h>
  24
  25 #include <set>
  26 #include <string>
  27
  28 /**\class ModelAPI_AttributeInteger
  29  * \ingroup DataModel
  30  * \brief API for the attribute that contains integer (int).
  31  */
  32
  33 class ModelAPI_AttributeInteger : public ModelAPI_Attribute
  34 {
  35  public:
  36   /// Defines the integer value
  37   MODELAPI_EXPORT virtual void setValue(const int theValue) = 0;
  38
  39   /// Returns the integer value
  40   MODELAPI_EXPORT virtual int value() = 0;
  41
  42   /// Defines the calculated value
  43   MODELAPI_EXPORT virtual void setCalculatedValue(const int theValue) = 0;
  44
  45   /// Defines the text value
  46   MODELAPI_EXPORT virtual void setText(const std::string& theText) = 0;
  47
  48   /// Returns the text value
  49   MODELAPI_EXPORT virtual std::string text() = 0;
  50
  51   /// Allows to set expression (text) as invalid (by the parameters listener)
  52   MODELAPI_EXPORT virtual void setExpressionInvalid(const bool theFlag) = 0;
  53
  54   /// Returns true if text is invalid
  55   MODELAPI_EXPORT virtual bool expressionInvalid() = 0;
  56
  57   /// Allows to set expression (text) error (by the parameters listener)
  58   MODELAPI_EXPORT virtual void setExpressionError(const std::string& theError) = 0;
  59
  60   /// Returns an expression error
  61   MODELAPI_EXPORT virtual std::string expressionError() = 0;
  62
  63   /// Defines the used parameters
  64   MODELAPI_EXPORT virtual
  65     void setUsedParameters(const std::set<std::string>& theUsedParameters) = 0;
  66
  67   /// Returns the used parameters
  68   MODELAPI_EXPORT virtual std::set<std::string> usedParameters() const = 0;
  69
  70   /// Returns the type of this class of attributes
  71   MODELAPI_EXPORT static std::string typeId()
  72   {
  73     return "Integer";
  74   }
  75
  76   /// Returns the type of this class of attributes, not static method
  77   MODELAPI_EXPORT virtual std::string attributeType();
  78
  79   /// To virtually destroy the fields of successors
  80   MODELAPI_EXPORT virtual ~ModelAPI_AttributeInteger();
  81
  82  protected:
  83   /// Objects are created for features automatically
  84   MODELAPI_EXPORT ModelAPI_AttributeInteger();
  85 };
  86
  87 //! Pointer on double attribute
  88 typedef std::shared_ptr<ModelAPI_AttributeInteger> AttributeIntegerPtr;
  89
  90 #endif