0031353: TDocStd_Application does not have api to set progress indicator
[occt.git] / src / BinTools / BinTools_SurfaceSet.hxx
1 // Created on: 2004-05-20
2 // Created by: Sergey ZARITCHNY <szy@opencascade.com>
3 // Copyright (c) 2004-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 _BinTools_SurfaceSet_HeaderFile
17 #define _BinTools_SurfaceSet_HeaderFile
18
19 #include <Standard.hxx>
20 #include <Standard_DefineAlloc.hxx>
21 #include <Standard_Handle.hxx>
22
23 #include <TColStd_IndexedMapOfTransient.hxx>
24 #include <Standard_Integer.hxx>
25 #include <Standard_OStream.hxx>
26 #include <Standard_IStream.hxx>
27
28 #include <Message_ProgressIndicator.hxx>
29
30 class Standard_OutOfRange;
31 class Geom_Surface;
32
33
34 //! Stores a set of Surfaces from Geom in binary format.
35 class BinTools_SurfaceSet 
36 {
37 public:
38
39   DEFINE_STANDARD_ALLOC
40
41   
42   //! Returns an empty set of Surfaces.
43   Standard_EXPORT BinTools_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   //! Writes the content of  me  on the stream <OS> in
59   //! binary format that can be read back by Read.
60   Standard_EXPORT void Write (Standard_OStream& OS,
61                               const Handle(Message_ProgressIndicator)& theProgress = NULL) const;
62   
63   //! Reads the content of me from the  stream  <IS>. me
64   //! is first cleared.
65   Standard_EXPORT void Read (Standard_IStream& IS,
66                              const Handle(Message_ProgressIndicator) &theProgress = NULL);
67   
68   //! Dumps the surface on the stream in binary
69   //! format that can be read back.
70   Standard_EXPORT static void WriteSurface (const Handle(Geom_Surface)& S, Standard_OStream& OS);
71   
72   //! Reads the surface  from  the stream.  The  surface  is
73   //! assumed   to have  been  written  with  the Write
74   //! method.
75   Standard_EXPORT static Standard_IStream& ReadSurface (Standard_IStream& IS, Handle(Geom_Surface)& S);
76
77 private:
78
79   TColStd_IndexedMapOfTransient myMap;
80
81 };
82
83 #endif // _BinTools_SurfaceSet_HeaderFile