Fix the point by XYZ coordinates python export/dump

[modules/shaper.git] / src / GeomDataAPI / GeomDataAPI_Point.h

diff --git a/src/GeomDataAPI/GeomDataAPI_Point.h b/src/GeomDataAPI/GeomDataAPI_Point.h
index 61eaf4a6b842aa24e69d08b315d359a319670015..d47e3048d6aead1f5d29553e27a698353bcd57d2 100644 (file)
--- a/src/GeomDataAPI/GeomDataAPI_Point.h
+++ b/src/GeomDataAPI/GeomDataAPI_Point.h
@@ -1,8 +1,22 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        GeomDataAPI_Point.h
-// Created:     24 Apr 2014
-// Author:      Mikhail PONIKAROV
+// Copyright (C) 2014-2017  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<mailto:webmaster.salome@opencascade.com>
+//
 
 #ifndef GeomDataAPI_Point_H_
 #define GeomDataAPI_Point_H_
@@ -10,6 +24,8 @@
 #include "GeomDataAPI.h"
 #include <ModelAPI_Attribute.h>
 
+#include <set>
+
 class GeomAPI_Pnt;
 
 /**\class GeomDataAPI_Point
@@ -21,7 +37,8 @@ class GeomDataAPI_Point : public ModelAPI_Attribute
 {
  public:
   /// Defines the double value
-  GEOMDATAAPI_EXPORT virtual void setValue(const double theX, const double theY, const double theZ) = 0;
+  GEOMDATAAPI_EXPORT virtual
+    void setValue(const double theX, const double theY, const double theZ) = 0;
   /// Defines the point
   GEOMDATAAPI_EXPORT virtual void setValue(const std::shared_ptr<GeomAPI_Pnt>& thePoint) = 0;
 
@@ -34,16 +51,37 @@ class GeomDataAPI_Point : public ModelAPI_Attribute
   /// Returns the 3D point
   GEOMDATAAPI_EXPORT virtual std::shared_ptr<GeomAPI_Pnt> pnt() = 0;
 
-  /// Defines the double values
+  /// Defines the calculated double value
+  GEOMDATAAPI_EXPORT virtual
+    void setCalculatedValue(const double theX, const double theY, const double theZ) = 0;
+
+  /// Defines the X coordinate value
+  GEOMDATAAPI_EXPORT virtual void setX(const double theX) = 0;
+  /// Defines the Y coordinate value
+  GEOMDATAAPI_EXPORT virtual void setY(const double theY) = 0;
+  /// Defines the Z coordinate value
+  GEOMDATAAPI_EXPORT virtual void setZ(const double theZ) = 0;
+
+  /// Defines the text values
   GEOMDATAAPI_EXPORT virtual void setText(const std::string& theX,
                                           const std::string& theY,
                                           const std::string& theZ) = 0;
 
-  /// Returns the double values
+  /// Defines the X text value
+  GEOMDATAAPI_EXPORT virtual void setTextX(const std::string& theX) = 0;
+  /// Defines the Y text value
+  GEOMDATAAPI_EXPORT virtual void setTextY(const std::string& theY) = 0;
+  /// Defines the Z text value
+  GEOMDATAAPI_EXPORT virtual void setTextZ(const std::string& theZ) = 0;
+
+  /// Returns the text value for X
   GEOMDATAAPI_EXPORT virtual std::string textX() = 0;
+  /// Returns the text value for Y
   GEOMDATAAPI_EXPORT virtual std::string textY() = 0;
+  /// Returns the text value for Z
   GEOMDATAAPI_EXPORT virtual std::string textZ() = 0;
 
+  /// Point component (x,y,z)
   enum PointComponent { C_X = 0,
                         C_Y = 1,
                         C_Z = 2,
@@ -55,6 +93,20 @@ class GeomDataAPI_Point : public ModelAPI_Attribute
   /// Returns true if text is invalid
   GEOMDATAAPI_EXPORT virtual bool expressionInvalid(int theComponent) = 0;
 
+  /// Allows to set expression (text) error (by the parameters listener)
+  GEOMDATAAPI_EXPORT virtual
+    void setExpressionError(int theComponent, const std::string& theError) = 0;
+
+  /// Returns an expression error
+  GEOMDATAAPI_EXPORT virtual std::string expressionError(int theComponent) = 0;
+
+  /// Defines the used parameters
+  GEOMDATAAPI_EXPORT virtual void setUsedParameters(int theComponent,
+    const std::set<std::string>& theUsedParameters) = 0;
+
+  /// Returns the used parameters
+  GEOMDATAAPI_EXPORT virtual std::set<std::string> usedParameters(int theComponent) const = 0;
+
   /// Returns the type of this class of attributes
   static std::string typeId()
   {
@@ -70,4 +122,7 @@ class GeomDataAPI_Point : public ModelAPI_Attribute
   GEOMDATAAPI_EXPORT virtual ~GeomDataAPI_Point();
 };
 
+//! Pointer on attribute object
+typedef std::shared_ptr<GeomDataAPI_Point> AttributePointPtr;
+
 #endif