1 // Copyright (C) 2014-2023 CEA, EDF
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef MODELAPI_ATTRIBUTEINTEGER_H_
21 #define MODELAPI_ATTRIBUTEINTEGER_H_
23 #include <ModelAPI_Attribute.h>
28 /**\class ModelAPI_AttributeInteger
30 * \brief API for the attribute that contains integer (int).
33 class ModelAPI_AttributeInteger : public ModelAPI_Attribute
36 /// Defines the integer value
37 MODELAPI_EXPORT virtual void setValue(const int theValue) = 0;
39 /// Returns the integer value
40 MODELAPI_EXPORT virtual int value() = 0;
42 /// Defines the calculated value
43 MODELAPI_EXPORT virtual void setCalculatedValue(const int theValue) = 0;
45 /// Defines the text value
46 MODELAPI_EXPORT virtual void setText(const std::wstring& theText) = 0;
48 /// Returns the text value
49 MODELAPI_EXPORT virtual std::wstring text() = 0;
51 /// Allows to set expression (text) as invalid (by the parameters listener)
52 MODELAPI_EXPORT virtual void setExpressionInvalid(const bool theFlag) = 0;
54 /// Returns true if text is invalid
55 MODELAPI_EXPORT virtual bool expressionInvalid() = 0;
57 /// Allows to set expression (text) error (by the parameters listener)
58 MODELAPI_EXPORT virtual void setExpressionError(const std::string& theError) = 0;
60 /// Returns an expression error
61 MODELAPI_EXPORT virtual std::string expressionError() = 0;
63 /// Defines the used parameters
64 MODELAPI_EXPORT virtual
65 void setUsedParameters(const std::set<std::wstring>& theUsedParameters) = 0;
67 /// Returns the used parameters
68 MODELAPI_EXPORT virtual std::set<std::wstring> usedParameters() const = 0;
70 /// Returns the type of this class of attributes
71 MODELAPI_EXPORT static std::string typeId()
76 /// Returns the type of this class of attributes, not static method
77 MODELAPI_EXPORT virtual std::string attributeType();
79 /// To virtually destroy the fields of successors
80 MODELAPI_EXPORT virtual ~ModelAPI_AttributeInteger();
83 /// Objects are created for features automatically
84 MODELAPI_EXPORT ModelAPI_AttributeInteger();
87 //! Pointer on double attribute
88 typedef std::shared_ptr<ModelAPI_AttributeInteger> AttributeIntegerPtr;