0025748: Parallel version of progress indicator
[occt.git] / src / XSAlgo / XSAlgo_AlgoContainer.hxx
1 // Created on: 2000-01-19
2 // Created by: data exchange team
3 // Copyright (c) 2000-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _XSAlgo_AlgoContainer_HeaderFile
17 #define _XSAlgo_AlgoContainer_HeaderFile
18
19 #include <Standard.hxx>
20 #include <Standard_Type.hxx>
21
22 #include <Standard_Transient.hxx>
23 #include <Standard_Real.hxx>
24 #include <Standard_CString.hxx>
25 #include <Standard_Boolean.hxx>
26 #include <Standard_Integer.hxx>
27 #include <Message_ProgressRange.hxx>
28
29 class XSAlgo_ToolContainer;
30 class TopoDS_Shape;
31 class Standard_Transient;
32 class TopoDS_Edge;
33 class TopoDS_Face;
34 class Transfer_TransientProcess;
35 class Transfer_FinderProcess;
36
37
38 class XSAlgo_AlgoContainer;
39 DEFINE_STANDARD_HANDLE(XSAlgo_AlgoContainer, Standard_Transient)
40
41
42 class XSAlgo_AlgoContainer : public Standard_Transient
43 {
44
45 public:
46
47   
48   //! Empty constructor
49   Standard_EXPORT XSAlgo_AlgoContainer();
50   
51   //! Sets ToolContainer
52     void SetToolContainer (const Handle(XSAlgo_ToolContainer)& TC);
53   
54   //! Returns ToolContainer
55     Handle(XSAlgo_ToolContainer) ToolContainer() const;
56   
57   //! Performs actions necessary for preparing environment
58   //! for transfer. Empty in Open version.
59   Standard_EXPORT virtual void PrepareForTransfer() const;
60   
61   //! Does shape processing with specified tolerances
62   //! and returns resulting shape and associated information
63   //! in the form of Transient.
64   //! This information should be later transmitted to
65   //! MergeTransferInfo in order to be recorded in the
66   //! translation map
67   Standard_EXPORT virtual TopoDS_Shape ProcessShape (
68       const TopoDS_Shape& shape, const Standard_Real Prec, const Standard_Real MaxTol,
69       const Standard_CString rscfile, const Standard_CString seq, Handle(Standard_Transient)& info,
70       const Message_ProgressRange& theProgress = Message_ProgressRange(),
71       const Standard_Boolean NonManifold = Standard_False) const;
72   
73   //! Checks quality of pcurve of the edge on the given face,
74   //! and corrects it if necessary.
75   Standard_EXPORT virtual Standard_Boolean CheckPCurve (const TopoDS_Edge& edge, const TopoDS_Face& face, const Standard_Real preci, const Standard_Boolean isSeam) const;
76   
77   Standard_EXPORT virtual void MergeTransferInfo (const Handle(Transfer_TransientProcess)& TP, const Handle(Standard_Transient)& info, const Standard_Integer startTPitem = 1) const;
78   
79   //! Updates translation map (TP or FP) with information
80   //! resulting from ShapeProcessing
81   //! Parameter startTPitem can be used for optimisation, to
82   //! restrict modifications to entities stored in TP starting
83   //! from item startTPitem
84   Standard_EXPORT virtual void MergeTransferInfo (const Handle(Transfer_FinderProcess)& FP, const Handle(Standard_Transient)& info) const;
85
86
87
88
89   DEFINE_STANDARD_RTTIEXT(XSAlgo_AlgoContainer,Standard_Transient)
90
91 protected:
92
93
94
95
96 private:
97
98
99   Handle(XSAlgo_ToolContainer) myTC;
100
101
102 };
103
104
105 #include <XSAlgo_AlgoContainer.lxx>
106
107
108
109
110
111 #endif // _XSAlgo_AlgoContainer_HeaderFile