Salome HOME
Fix documentation problems (reported as doxygen warnings)
[modules/geom.git] / src / NMTAlgo / NMTAlgo_Algo.hxx
1 //  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 //  Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
6 //  This library is free software; you can redistribute it and/or
7 //  modify it under the terms of the GNU Lesser General Public
8 //  License as published by the Free Software Foundation; either
9 //  version 2.1 of the License.
10 //
11 //  This library is distributed in the hope that it will be useful,
12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14 //  Lesser General Public License for more details.
15 //
16 //  You should have received a copy of the GNU Lesser General Public
17 //  License along with this library; if not, write to the Free Software
18 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19 //
20 //  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22 #ifndef _NMTAlgo_Algo_HeaderFile
23 #define _NMTAlgo_Algo_HeaderFile
24
25 #ifndef _NMTTools_PDSFiller_HeaderFile
26 #include <NMTTools_PDSFiller.hxx>
27 #endif
28 #ifndef _TopoDS_Shape_HeaderFile
29 #include <TopoDS_Shape.hxx>
30 #endif
31 #ifndef _Standard_Boolean_HeaderFile
32 #include <Standard_Boolean.hxx>
33 #endif
34 #ifndef _Standard_Integer_HeaderFile
35 #include <Standard_Integer.hxx>
36 #endif
37 class NMTTools_DSFiller;
38 class TopoDS_Shape;
39
40
41 #ifndef _Standard_HeaderFile
42 #include <Standard.hxx>
43 #endif
44 #ifndef _Standard_Macro_HeaderFile
45 #include <Standard_Macro.hxx>
46 #endif
47
48 class NMTAlgo_Algo  {
49
50 public:
51
52     void* operator new(size_t,void* anAddress) 
53       {
54         return anAddress;
55       }
56     void* operator new(size_t size) 
57       { 
58         return Standard::Allocate(size); 
59       }
60     void  operator delete(void *anAddress) 
61       { 
62         if (anAddress) Standard::Free((Standard_Address&)anAddress); 
63       }
64  // Methods PUBLIC
65  // 
66 Standard_EXPORT   void SetFiller(const NMTTools_DSFiller& aDSF) ;
67 Standard_EXPORT  const NMTTools_DSFiller& Filler() const;
68 Standard_EXPORT virtual  void ComputeWithFiller(const NMTTools_DSFiller& aDSF) ;
69 Standard_EXPORT virtual  void Clear() ;
70 Standard_EXPORT  const TopoDS_Shape& Shape() const;
71 Standard_EXPORT   Standard_Boolean IsDone() const;
72 Standard_EXPORT   Standard_Integer ErrorStatus() const;
73
74
75
76
77
78 protected:
79
80  // Methods PROTECTED
81  // 
82 Standard_EXPORT NMTAlgo_Algo();
83 Standard_EXPORT virtual ~NMTAlgo_Algo();
84
85
86  // Fields PROTECTED
87  //
88 NMTTools_PDSFiller myDSFiller;
89 TopoDS_Shape myShape;
90 Standard_Boolean myIsDone;
91 Standard_Boolean myIsComputed;
92 Standard_Integer myErrorStatus;
93 Standard_Integer myDraw;
94
95
96 private: 
97
98  // Methods PRIVATE
99  // 
100
101
102  // Fields PRIVATE
103  //
104
105
106 };
107
108
109
110
111
112 // other Inline functions and methods (like "C++: function call" methods)
113 //
114
115
116 #endif