SHAPER  9.12.0
ModelAPI_AttributeInteger.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 MODELAPI_ATTRIBUTEINTEGER_H_
21 #define MODELAPI_ATTRIBUTEINTEGER_H_
22 
23 #include <ModelAPI_Attribute.h>
24 
25 #include <set>
26 #include <string>
27 
34 {
35  public:
37  MODELAPI_EXPORT virtual void setValue(const int theValue) = 0;
38 
40  MODELAPI_EXPORT virtual int value() = 0;
41 
43  MODELAPI_EXPORT virtual void setCalculatedValue(const int theValue) = 0;
44 
46  MODELAPI_EXPORT virtual void setText(const std::wstring& theText) = 0;
47 
49  MODELAPI_EXPORT virtual std::wstring text() = 0;
50 
52  MODELAPI_EXPORT virtual void setExpressionInvalid(const bool theFlag) = 0;
53 
55  MODELAPI_EXPORT virtual bool expressionInvalid() = 0;
56 
58  MODELAPI_EXPORT virtual void setExpressionError(const std::string& theError) = 0;
59 
61  MODELAPI_EXPORT virtual std::string expressionError() = 0;
62 
64  MODELAPI_EXPORT virtual
65  void setUsedParameters(const std::set<std::wstring>& theUsedParameters) = 0;
66 
68  MODELAPI_EXPORT virtual std::set<std::wstring> usedParameters() const = 0;
69 
71  MODELAPI_EXPORT static std::string typeId()
72  {
73  return "Integer";
74  }
75 
77  MODELAPI_EXPORT virtual std::string attributeType();
78 
80  MODELAPI_EXPORT virtual ~ModelAPI_AttributeInteger();
81 
82  protected:
84  MODELAPI_EXPORT ModelAPI_AttributeInteger();
85 };
86 
88 typedef std::shared_ptr<ModelAPI_AttributeInteger> AttributeIntegerPtr;
89 
90 #endif
API for the attribute that contains integer (int).
Definition: ModelAPI_AttributeInteger.h:34
virtual MODELAPI_EXPORT bool expressionInvalid()=0
Returns true if text is invalid.
virtual MODELAPI_EXPORT std::string attributeType()
Returns the type of this class of attributes, not static method.
Definition: ModelAPI_AttributeInteger.cpp:23
virtual MODELAPI_EXPORT int value()=0
Returns the integer value.
virtual MODELAPI_EXPORT void setText(const std::wstring &theText)=0
Defines the text value.
static MODELAPI_EXPORT std::string typeId()
Returns the type of this class of attributes.
Definition: ModelAPI_AttributeInteger.h:71
virtual MODELAPI_EXPORT void setUsedParameters(const std::set< std::wstring > &theUsedParameters)=0
Defines the used parameters.
virtual MODELAPI_EXPORT std::set< std::wstring > usedParameters() const =0
Returns the used parameters.
virtual MODELAPI_EXPORT void setCalculatedValue(const int theValue)=0
Defines the calculated value.
virtual MODELAPI_EXPORT void setValue(const int theValue)=0
Defines the integer value.
virtual MODELAPI_EXPORT void setExpressionError(const std::string &theError)=0
Allows to set expression (text) error (by the parameters listener)
virtual MODELAPI_EXPORT std::wstring text()=0
Returns the text value.
MODELAPI_EXPORT ModelAPI_AttributeInteger()
Objects are created for features automatically.
Definition: ModelAPI_AttributeInteger.cpp:33
virtual MODELAPI_EXPORT void setExpressionInvalid(const bool theFlag)=0
Allows to set expression (text) as invalid (by the parameters listener)
virtual MODELAPI_EXPORT std::string expressionError()=0
Returns an expression error.
virtual MODELAPI_EXPORT ~ModelAPI_AttributeInteger()
To virtually destroy the fields of successors.
Definition: ModelAPI_AttributeInteger.cpp:29
Generic attribute of the Object.
Definition: ModelAPI_Attribute.h:34