0025748: Parallel version of progress indicator
[occt.git] / src / GeomTools / GeomTools_SurfaceSet.hxx
1 // Created on: 1993-07-19
2 // Created by: Remi LEQUETTE
3 // Copyright (c) 1993-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 _GeomTools_SurfaceSet_HeaderFile
18 #define _GeomTools_SurfaceSet_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <TColStd_IndexedMapOfTransient.hxx>
25 #include <Standard_Integer.hxx>
26 #include <Standard_OStream.hxx>
27 #include <Standard_IStream.hxx>
28 #include <Standard_Boolean.hxx>
29 #include <Message_ProgressRange.hxx>
30
31 class Standard_OutOfRange;
32 class Geom_Surface;
33
34
35 //! Stores a set of Surfaces from Geom.
36 class GeomTools_SurfaceSet 
37 {
38 public:
39
40   DEFINE_STANDARD_ALLOC
41
42   
43   //! Returns an empty set of Surfaces.
44   Standard_EXPORT GeomTools_SurfaceSet();
45   
46   //! Clears the content of the set.
47   Standard_EXPORT void Clear();
48   
49   //! Incorporate a new Surface in the  set and returns
50   //! its index.
51   Standard_EXPORT Standard_Integer Add (const Handle(Geom_Surface)& S);
52   
53   //! Returns the Surface of index <I>.
54   Standard_EXPORT Handle(Geom_Surface) Surface (const Standard_Integer I) const;
55   
56   //! Returns the index of <L>.
57   Standard_EXPORT Standard_Integer Index (const Handle(Geom_Surface)& S) const;
58   
59   //! Dumps the content of me on the stream <OS>.
60   Standard_EXPORT void Dump (Standard_OStream& OS) const;
61   
62   //! Writes the content of  me  on the stream <OS> in a
63   //! format that can be read back by Read.
64   Standard_EXPORT void Write (Standard_OStream& OS,
65                               const Message_ProgressRange& theProgress = Message_ProgressRange()) const;
66   
67   //! Reads the content of me from the  stream  <IS>. me
68   //! is first cleared.
69   Standard_EXPORT void Read (Standard_IStream& IS,
70                              const Message_ProgressRange& theProgress = Message_ProgressRange());
71   
72   //! Dumps the surface on the stream,  if compact is True
73   //! use the compact format that can be read back.
74   Standard_EXPORT static void PrintSurface (const Handle(Geom_Surface)& S,
75                                             Standard_OStream& OS,
76                                             const Standard_Boolean compact = Standard_False);
77   
78   //! Reads the surface  from  the stream.  The  surface  is
79   //! assumed   to have  been  written  with  the Print
80   //! method (compact = True).
81   Standard_EXPORT static Handle(Geom_Surface) ReadSurface (Standard_IStream& IS);
82
83 private:
84
85   TColStd_IndexedMapOfTransient myMap;
86
87 };
88
89 #endif // _GeomTools_SurfaceSet_HeaderFile