0025748: Parallel version of progress indicator
[occt.git] / src / ShapeProcessAPI / ShapeProcessAPI_ApplySequence.hxx
1 // Created on: 1999-06-22
2 // Created by: data exchange team
3 // Copyright (c) 1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _ShapeProcessAPI_ApplySequence_HeaderFile
18 #define _ShapeProcessAPI_ApplySequence_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <TopTools_DataMapOfShapeShape.hxx>
25 #include <TCollection_AsciiString.hxx>
26 #include <Standard_CString.hxx>
27 #include <Standard_Boolean.hxx>
28 #include <TopAbs_ShapeEnum.hxx>
29 #include <Message_ProgressRange.hxx>
30
31 class ShapeProcess_ShapeContext;
32 class TopoDS_Shape;
33
34 //! Applies one of the sequence read from resource file.
35 class ShapeProcessAPI_ApplySequence 
36 {
37 public:
38
39   DEFINE_STANDARD_ALLOC
40
41   
42   //! Creates an object and loads resource file and sequence of
43   //! operators given by their names.
44   Standard_EXPORT ShapeProcessAPI_ApplySequence(const Standard_CString rscName, const Standard_CString seqName = "");
45   
46   //! Returns object for managing resource file and sequence of
47   //! operators.
48   Standard_EXPORT Handle(ShapeProcess_ShapeContext)& Context();
49   
50   //! Performs sequence of operators stored in myRsc.
51   //! If <fillmap> is True adds history "shape-shape" into myMap
52   //! for shape and its subshapes until level <until> (included).
53   //! If <until> is TopAbs_SHAPE,  all the subshapes are considered.
54   Standard_EXPORT TopoDS_Shape PrepareShape (const TopoDS_Shape& shape,
55                                              const Standard_Boolean fillmap = Standard_False,
56                                              const TopAbs_ShapeEnum until = TopAbs_SHAPE, 
57                                              const Message_ProgressRange& theProgress = Message_ProgressRange());
58   
59   //! Clears myMap with accumulated history.
60   Standard_EXPORT void ClearMap();
61   
62   //! Returns myMap with accumulated history.
63   Standard_EXPORT const TopTools_DataMapOfShapeShape& Map() const;
64   
65   //! Prints result of preparation onto the messenger of the context.
66   //! Note that results can be accumulated from previous preparations
67   //! it method ClearMap was not called before PrepareShape.
68   Standard_EXPORT void PrintPreparationResult() const;
69
70
71
72
73 protected:
74
75
76
77
78
79 private:
80
81
82
83   Handle(ShapeProcess_ShapeContext) myContext;
84   TopTools_DataMapOfShapeShape myMap;
85   TCollection_AsciiString mySeq;
86
87
88 };
89
90
91
92
93
94
95
96 #endif // _ShapeProcessAPI_ApplySequence_HeaderFile