Salome HOME
updated copyright message
[modules/shaper.git] / src / ModelAPI / ModelAPI_AttributeDouble.h
index 7dfb882c308d8adb883f71304d0efc3f8fb706d0..a6cc6d933f551288d011cc465dc55c6e76b43317 100644 (file)
@@ -1,36 +1,90 @@
-// File:        ModelAPI_AttributeDouble.h
-// Created:     2 Apr 2014
-// Author:      Mikhail PONIKAROV
+// Copyright (C) 2014-2023  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
-#ifndef ModelAPI_AttributeDouble_HeaderFile
-#define ModelAPI_AttributeDouble_HeaderFile
+#ifndef ModelAPI_AttributeDouble_H_
+#define ModelAPI_AttributeDouble_H_
 
-#include "ModelAPI_Attribute.h"
+#include <ModelAPI_Attribute.h>
+
+#include <set>
+#include <string>
 
 /**\class ModelAPI_AttributeDouble
  * \ingroup DataModel
  * \brief Attribute that contains real value with double precision.
  */
 
-class MODELAPI_EXPORT ModelAPI_AttributeDouble : public ModelAPI_Attribute
+class ModelAPI_AttributeDouble : public ModelAPI_Attribute
 {
-public:
+ public:
   /// Defines the double value
-  virtual void setValue(double theValue) = 0;
+  MODELAPI_EXPORT virtual void setValue(const double theValue) = 0;
 
   /// Returns the double value
-  virtual double value() = 0;
+  MODELAPI_EXPORT virtual double value() = 0;
+
+  /// Defines the calculated double value
+  MODELAPI_EXPORT virtual void setCalculatedValue(const double theValue) = 0;
+
+  /// Defines the text value
+  MODELAPI_EXPORT virtual void setText(const std::wstring& theText) = 0;
+
+  /// Returns the text value
+  MODELAPI_EXPORT virtual std::wstring text() = 0;
+
+  /// Allows to set expression (text) as invalid (by the parameters listener)
+  MODELAPI_EXPORT virtual void setExpressionInvalid(const bool theFlag) = 0;
+
+  /// Returns true if text is invalid
+  MODELAPI_EXPORT virtual bool expressionInvalid() = 0;
+
+  /// Allows to set expression (text) error (by the parameters listener)
+  MODELAPI_EXPORT virtual void setExpressionError(const std::string& theError) = 0;
+
+  /// Returns an expression error
+  MODELAPI_EXPORT virtual std::string expressionError() = 0;
+
+  /// Defines the used parameters
+  MODELAPI_EXPORT virtual
+    void setUsedParameters(const std::set<std::wstring>& theUsedParameters) = 0;
+
+  /// Returns the used parameters
+  MODELAPI_EXPORT virtual std::set<std::wstring> usedParameters() const = 0;
 
   /// Returns the type of this class of attributes
-  static std::string type() {return "Double";}
+  MODELAPI_EXPORT static std::string typeId()
+  {
+    return "Double";
+  }
 
   /// Returns the type of this class of attributes, not static method
-  virtual std::string attributeType() {return type();}
+  MODELAPI_EXPORT virtual std::string attributeType();
+
+  /// To virtually destroy the fields of successors
+  MODELAPI_EXPORT virtual ~ModelAPI_AttributeDouble();
 
-protected:
+ protected:
   /// Objects are created for features automatically
-  ModelAPI_AttributeDouble()
-  {}
+  MODELAPI_EXPORT ModelAPI_AttributeDouble();
 };
 
+//! Pointer on double attribute
+typedef std::shared_ptr<ModelAPI_AttributeDouble> AttributeDoublePtr;
+
 #endif