Updated for PAL14857.

[modules/geom.git] / src / NMTTools / NMTTools_DEProcessor.hxx

diff --git a/src/NMTTools/NMTTools_DEProcessor.hxx b/src/NMTTools/NMTTools_DEProcessor.hxx
index 8da33e72b43a98dd6650a2974b58ddc0e98cc396..dfd14933593aca38c6f1a9dc8fc3a916bd66b9bd 100644 (file)
--- a/src/NMTTools/NMTTools_DEProcessor.hxx
+++ b/src/NMTTools/NMTTools_DEProcessor.hxx
@@ -1,18 +1,18 @@
 // Copyright (C) 2005  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
-// 
+//
 // 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 
+// License as published by the Free Software Foundation; either
 // version 2.1 of the License.
-// 
-// 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 
+//
+// 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 
+// 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
@@ -52,6 +52,15 @@ class TopoDS_Vertex;
 #include <Standard_Macro.hxx>
 #endif
 
+
+//! <br>
+//!  The  Algorithm to compute and store in interferences' pool <br>
+//! and in the Data  Structure  the following values <br>
+//! for degenerated edges <br>
+//!         1.  Paves/Pave set(s) <br>
+//!         2.  Split parts <br>
+//!         3.  States (3D) for split parts <br>
+//! <br>
 class NMTTools_DEProcessor  {
 
 public:
@@ -70,8 +79,20 @@ public:
       }
  // Methods PUBLIC
  // 
+
+
+//! Constructor <br>
+//! <br>
+//! Constructor <br>
+//! <br>
 Standard_EXPORT NMTTools_DEProcessor(NMTTools_PaveFiller& aFiller);
+
+
+//! Launches the processor <br>
 Standard_EXPORT   void Do() ;
+
+
+//! Returns TRUE if it is Ok <br>
 Standard_EXPORT   Standard_Boolean IsDone() const;
 
 
@@ -82,12 +103,26 @@ protected:
 
  // Methods PROTECTED
  // 
+
+
 Standard_EXPORT   void FindDegeneratedEdges() ;
+
+
 Standard_EXPORT   void DoPaves() ;
+
+
 Standard_EXPORT   void FindPaveBlocks(const Standard_Integer nED,const Standard_Integer nVD,const Standard_Integer nFD,BOPTools_ListOfPaveBlock& aLPB) ;
+
+
 Standard_EXPORT   void FillPaveSet(const Standard_Integer nED,const Standard_Integer nVD,const Standard_Integer nFD,const BOPTools_ListOfPaveBlock& aLPB) ;
+
+
 Standard_EXPORT   void FillSplitEdgesPool(const Standard_Integer nED) ;
+
+
 Standard_EXPORT   void MakeSplitEdges(const Standard_Integer nED,const Standard_Integer nFD) ;
+
+
 Standard_EXPORT   void MakeSplitEdge(const TopoDS_Edge& aS1,const TopoDS_Face& aF,const TopoDS_Vertex& aV1,const Standard_Real aP1,const TopoDS_Vertex& aV2,const Standard_Real aP2,TopoDS_Edge& aNewEdge) ;