src/GeomDataAPI/GeomDataAPI_Point.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        GeomDataAPI_Point.h
   4 // Created:     24 Apr 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef GeomDataAPI_Point_H_
   8 #define GeomDataAPI_Point_H_
   9
  10 #include "GeomDataAPI.h"
  11 #include <ModelAPI_Attribute.h>
  12
  13 #include <set>
  14
  15 class GeomAPI_Pnt;
  16
  17 /**\class GeomDataAPI_Point
  18  * \ingroup DataModel
  19  * \brief Attribute that contains 3D point coordinates.
  20  */
  21
  22 class GeomDataAPI_Point : public ModelAPI_Attribute
  23 {
  24  public:
  25   /// Defines the double value
  26   GEOMDATAAPI_EXPORT virtual void setValue(const double theX, const double theY, const double theZ) = 0;
  27   /// Defines the point
  28   GEOMDATAAPI_EXPORT virtual void setValue(const std::shared_ptr<GeomAPI_Pnt>& thePoint) = 0;
  29
  30   /// Returns the X double value
  31   GEOMDATAAPI_EXPORT virtual double x() const = 0;
  32   /// Returns the Y double value
  33   GEOMDATAAPI_EXPORT virtual double y() const = 0;
  34   /// Returns the Z double value
  35   GEOMDATAAPI_EXPORT virtual double z() const = 0;
  36   /// Returns the 3D point
  37   GEOMDATAAPI_EXPORT virtual std::shared_ptr<GeomAPI_Pnt> pnt() = 0;
  38
  39   /// Defines the calculated double value
  40   GEOMDATAAPI_EXPORT virtual void setCalculatedValue(const double theX, const double theY, const double theZ) = 0;
  41
  42   /// Defines the text values
  43   GEOMDATAAPI_EXPORT virtual void setText(const std::string& theX,
  44                                           const std::string& theY,
  45                                           const std::string& theZ) = 0;
  46
  47   /// Returns the text value for X
  48   GEOMDATAAPI_EXPORT virtual std::string textX() = 0;
  49   /// Returns the text value for Y
  50   GEOMDATAAPI_EXPORT virtual std::string textY() = 0;
  51   /// Returns the text value for Z
  52   GEOMDATAAPI_EXPORT virtual std::string textZ() = 0;
  53
  54   /// Point component (x,y,z)
  55   enum PointComponent { C_X = 0,
  56                         C_Y = 1,
  57                         C_Z = 2,
  58   };
  59
  60   /// Allows to set expression (text) as invalid (by the parameters listener)
  61   GEOMDATAAPI_EXPORT virtual void setExpressionInvalid(int theComponent, const bool theFlag) = 0;
  62
  63   /// Returns true if text is invalid
  64   GEOMDATAAPI_EXPORT virtual bool expressionInvalid(int theComponent) = 0;
  65
  66   /// Allows to set expression (text) error (by the parameters listener)
  67   GEOMDATAAPI_EXPORT virtual void setExpressionError(int theComponent, const std::string& theError) = 0;
  68
  69   /// Returns an expression error
  70   GEOMDATAAPI_EXPORT virtual std::string expressionError(int theComponent) = 0;
  71
  72   /// Defines the used parameters
  73   GEOMDATAAPI_EXPORT virtual void setUsedParameters(int theComponent,
  74     const std::set<std::string>& theUsedParameters) = 0;
  75
  76   /// Returns the used parameters
  77   GEOMDATAAPI_EXPORT virtual std::set<std::string> usedParameters(int theComponent) const = 0;
  78
  79   /// Returns the type of this class of attributes
  80   static std::string typeId()
  81   {
  82     return std::string("Point");
  83   }
  84
  85   /// Returns the type of this class of attributes, not static method
  86   GEOMDATAAPI_EXPORT virtual std::string attributeType();
  87
  88  protected:
  89   /// Objects are created for features automatically
  90   GEOMDATAAPI_EXPORT GeomDataAPI_Point();
  91   GEOMDATAAPI_EXPORT virtual ~GeomDataAPI_Point();
  92 };
  93
  94 //! Pointer on attribute object
  95 typedef std::shared_ptr<GeomDataAPI_Point> AttributePointPtr;
  96
  97 #endif