Salome HOME
Updated copyright comment
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Measurement.h
index 562d998a7537e3f75074510b93ae62465c40a4b9..f2b79b6806642b8175e4e804d2c846991b69eafc 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2018-20xx  CEA/DEN, EDF R&D
+// Copyright (C) 2018-2024  CEA, EDF
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 //
 // 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
+// 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>
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
 #ifndef FeaturesPlugin_Measurement_H_
@@ -75,6 +74,13 @@ public:
     return MY_MEASURE_ID;
   }
 
+  /// Attribute name for distance measure.
+  inline static const std::string& MEASURE_PROXIMITY()
+  {
+    static const std::string MY_MEASURE_ID("Proximity");
+    return MY_MEASURE_ID;
+  }
+
   /// Attribute name for radius measure.
   inline static const std::string& MEASURE_RADIUS()
   {
@@ -174,7 +180,7 @@ public:
     return MY_RESULT_VALUES_ID;
   }
 
-  /// Creates a new part document if needed
+  /// Performs the algorithm and stores results it in the data structure.
   FEATURESPLUGIN_EXPORT virtual void execute();
 
   /// Request for initialization of data model of the feature: adding all attributes
@@ -212,7 +218,9 @@ private:
   void computeLength();
   /// Compute minimal distance between pair of shapes
   void computeDistance();
-  /// Compute radius of circular edge or cylindrical face
+  /// Compute proximity (maximum of all minimal distances between pair of shapes)
+  void computeProximity();
+  /// Compute radius of circular edge, cylindrical surface or sphere.
   void computeRadius();
   /// Compute angle(s) between pair of edges if they are intersected
   void computeAngle();