0031366: Documentation - Doxygen warnings in Standard_Dump.hxx
[occt.git] / src / BRepAlgoAPI / BRepAlgoAPI_Algo.hxx
1 // Created by: Peter KURNEV
2 // Copyright (c) 2014 OPEN CASCADE SAS
3 //
4 // This file is part of Open CASCADE Technology software library.
5 //
6 // This library is free software; you can redistribute it and/or modify it under
7 // the terms of the GNU Lesser General Public License version 2.1 as published
8 // by the Free Software Foundation, with special exception defined in the file
9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
10 // distribution for complete text of the license and disclaimer of any warranty.
11 //
12 // Alternatively, this file may be used under the terms of Open CASCADE
13 // commercial license or contractual agreement.
14
15 #ifndef _BRepAlgoAPI_Algo_HeaderFile
16 #define _BRepAlgoAPI_Algo_HeaderFile
17
18 #include <Standard.hxx>
19 #include <Standard_DefineAlloc.hxx>
20 #include <Standard_Handle.hxx>
21
22 #include <NCollection_BaseAllocator.hxx>
23 #include <Standard_Integer.hxx>
24 #include <Standard_Boolean.hxx>
25 #include <BRepBuilderAPI_MakeShape.hxx>
26 #include <BOPAlgo_Options.hxx>
27 class Message_ProgressIndicator;
28 class TopoDS_Shape;
29
30
31 //! Provides the root interface for the API algorithms
32
33 class BRepAlgoAPI_Algo : public BRepBuilderAPI_MakeShape,
34                          protected BOPAlgo_Options
35 {
36 public:
37
38   DEFINE_STANDARD_ALLOC
39
40   Standard_EXPORT virtual const TopoDS_Shape& Shape() Standard_OVERRIDE;
41
42   // Provide access to methods of protected base class BOPAlgo_Options
43   // (inherited as protected to avoid problems with SWIG wrapper)
44   using BOPAlgo_Options::Clear;
45   using BOPAlgo_Options::SetRunParallel;
46   using BOPAlgo_Options::RunParallel;
47   using BOPAlgo_Options::SetFuzzyValue;
48   using BOPAlgo_Options::FuzzyValue;
49   using BOPAlgo_Options::HasErrors;
50   using BOPAlgo_Options::HasWarnings;
51   using BOPAlgo_Options::HasError;
52   using BOPAlgo_Options::HasWarning;
53   using BOPAlgo_Options::DumpErrors;
54   using BOPAlgo_Options::DumpWarnings;
55   using BOPAlgo_Options::ClearWarnings;
56   using BOPAlgo_Options::GetReport;
57   using BOPAlgo_Options::SetProgressIndicator;
58   using BOPAlgo_Options::SetUseOBB;
59
60 protected:
61
62   //! Empty constructor
63   Standard_EXPORT BRepAlgoAPI_Algo();
64
65   //! Destructor
66   Standard_EXPORT virtual ~BRepAlgoAPI_Algo();
67
68   //! Empty constructor
69   Standard_EXPORT BRepAlgoAPI_Algo(const Handle(NCollection_BaseAllocator)& theAllocator);
70
71 private:
72
73 };
74
75 #endif // _BRepAlgoAPI_Algo_HeaderFile