0031353: TDocStd_Application does not have api to set 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 class Message_ProgressIndicator;
30 class Standard_OutOfRange;
31 class Geom_Surface;
32
33
34 //! Stores a set of Surfaces from Geom.
35 class GeomTools_SurfaceSet 
36 {
37 public:
38
39   DEFINE_STANDARD_ALLOC
40
41   
42   //! Returns an empty set of Surfaces.
43   Standard_EXPORT GeomTools_SurfaceSet();
44   
45   //! Clears the content of the set.
46   Standard_EXPORT void Clear();
47   
48   //! Incorporate a new Surface in the  set and returns
49   //! its index.
50   Standard_EXPORT Standard_Integer Add (const Handle(Geom_Surface)& S);
51   
52   //! Returns the Surface of index <I>.
53   Standard_EXPORT Handle(Geom_Surface) Surface (const Standard_Integer I) const;
54   
55   //! Returns the index of <L>.
56   Standard_EXPORT Standard_Integer Index (const Handle(Geom_Surface)& S) const;
57   
58   //! Dumps the content of me on the stream <OS>.
59   Standard_EXPORT void Dump (Standard_OStream& OS) const;
60   
61   //! Writes the content of  me  on the stream <OS> in a
62   //! format that can be read back by Read.
63   Standard_EXPORT void Write (Standard_OStream& OS,
64                               const Handle(Message_ProgressIndicator)& theProgress = NULL) const;
65   
66   //! Reads the content of me from the  stream  <IS>. me
67   //! is first cleared.
68   Standard_EXPORT void Read (Standard_IStream& IS,
69                              const Handle(Message_ProgressIndicator)& theProgress = NULL);
70   
71   //! Dumps the surface on the stream,  if compact is True
72   //! use the compact format that can be read back.
73   Standard_EXPORT static void PrintSurface (const Handle(Geom_Surface)& S,
74                                             Standard_OStream& OS,
75                                             const Standard_Boolean compact = Standard_False);
76   
77   //! Reads the surface  from  the stream.  The  surface  is
78   //! assumed   to have  been  written  with  the Print
79   //! method (compact = True).
80   Standard_EXPORT static Handle(Geom_Surface) ReadSurface (Standard_IStream& IS);
81
82 private:
83
84   TColStd_IndexedMapOfTransient myMap;
85
86 };
87
88 #endif // _GeomTools_SurfaceSet_HeaderFile