0025748: Parallel version of progress indicator
[occt.git] / src / BinTools / BinTools.hxx
1 // Created on: 2004-05-11
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_HeaderFile
17 #define _BinTools_HeaderFile
18
19 #include <Standard.hxx>
20 #include <Standard_DefineAlloc.hxx>
21 #include <Standard_Handle.hxx>
22
23 #include <Standard_Real.hxx>
24 #include <Standard_Integer.hxx>
25 #include <Standard_Boolean.hxx>
26 #include <Standard_ExtCharacter.hxx>
27 #include <Standard_OStream.hxx>
28 #include <Standard_IStream.hxx>
29 #include <Message_ProgressRange.hxx>
30
31 class TopoDS_Shape;
32 class BinTools_ShapeSet;
33 class BinTools_Curve2dSet;
34 class BinTools_CurveSet;
35 class BinTools_SurfaceSet;
36 class BinTools_LocationSet;
37
38
39 //! Tool to keep shapes in binary format
40 class BinTools 
41 {
42 public:
43
44   DEFINE_STANDARD_ALLOC
45
46   Standard_EXPORT static Standard_OStream& PutReal (Standard_OStream& OS, const Standard_Real& theValue);
47
48   Standard_EXPORT static Standard_OStream& PutShortReal (Standard_OStream& OS, const Standard_ShortReal& theValue);
49
50   Standard_EXPORT static Standard_OStream& PutInteger (Standard_OStream& OS, const Standard_Integer theValue);
51   
52   Standard_EXPORT static Standard_OStream& PutBool (Standard_OStream& OS, const Standard_Boolean theValue);
53   
54   Standard_EXPORT static Standard_OStream& PutExtChar (Standard_OStream& OS, const Standard_ExtCharacter theValue);
55   
56   Standard_EXPORT static Standard_IStream& GetReal (Standard_IStream& IS, Standard_Real& theValue);
57
58   Standard_EXPORT static Standard_IStream& GetShortReal (Standard_IStream& IS, Standard_ShortReal& theValue);
59
60   Standard_EXPORT static Standard_IStream& GetInteger (Standard_IStream& IS, Standard_Integer& theValue);
61   
62   Standard_EXPORT static Standard_IStream& GetBool (Standard_IStream& IS, Standard_Boolean& theValue);
63   
64   Standard_EXPORT static Standard_IStream& GetExtChar (Standard_IStream& IS, Standard_ExtCharacter& theValue);
65   
66   //! Writes <theShape> on <theStream> in binary format.
67   Standard_EXPORT static void Write (const TopoDS_Shape& theShape, Standard_OStream& theStream,
68                                      const Message_ProgressRange& theRange = Message_ProgressRange());
69   
70   //! Reads a shape from <theStream> and returns it in <theShape>.
71   Standard_EXPORT static void Read (TopoDS_Shape& theShape, Standard_IStream& theStream,
72                                     const Message_ProgressRange& theRange = Message_ProgressRange());
73   
74   //! Writes <theShape> in <theFile>.
75   Standard_EXPORT static Standard_Boolean Write
76     (const TopoDS_Shape& theShape, const Standard_CString theFile,
77      const Message_ProgressRange& theRange = Message_ProgressRange());
78   
79   //! Reads a shape from <theFile> and returns it in <theShape>.
80   Standard_EXPORT static Standard_Boolean Read
81     (TopoDS_Shape& theShape, const Standard_CString theFile,
82      const Message_ProgressRange& theRange = Message_ProgressRange());
83
84 protected:
85
86
87
88
89
90 private:
91
92
93
94
95 friend class BinTools_ShapeSet;
96 friend class BinTools_Curve2dSet;
97 friend class BinTools_CurveSet;
98 friend class BinTools_SurfaceSet;
99 friend class BinTools_LocationSet;
100
101 };
102
103
104
105
106
107
108
109 #endif // _BinTools_HeaderFile