0031137: Modeling Data, BinTools_ShapeSet - avoid allocation of temporary arrays
[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
30 class TopoDS_Shape;
31 class BinTools_ShapeSet;
32 class BinTools_Curve2dSet;
33 class BinTools_CurveSet;
34 class BinTools_SurfaceSet;
35 class BinTools_LocationSet;
36
37
38 //! Tool to keep shapes in binary format
39 class BinTools 
40 {
41 public:
42
43   DEFINE_STANDARD_ALLOC
44
45   Standard_EXPORT static Standard_OStream& PutReal (Standard_OStream& OS, const Standard_Real& theValue);
46
47   Standard_EXPORT static Standard_OStream& PutShortReal (Standard_OStream& OS, const Standard_ShortReal& theValue);
48
49   Standard_EXPORT static Standard_OStream& PutInteger (Standard_OStream& OS, const Standard_Integer theValue);
50   
51   Standard_EXPORT static Standard_OStream& PutBool (Standard_OStream& OS, const Standard_Boolean theValue);
52   
53   Standard_EXPORT static Standard_OStream& PutExtChar (Standard_OStream& OS, const Standard_ExtCharacter theValue);
54   
55   Standard_EXPORT static Standard_IStream& GetReal (Standard_IStream& IS, Standard_Real& theValue);
56
57   Standard_EXPORT static Standard_IStream& GetShortReal (Standard_IStream& IS, Standard_ShortReal& theValue);
58
59   Standard_EXPORT static Standard_IStream& GetInteger (Standard_IStream& IS, Standard_Integer& theValue);
60   
61   Standard_EXPORT static Standard_IStream& GetBool (Standard_IStream& IS, Standard_Boolean& theValue);
62   
63   Standard_EXPORT static Standard_IStream& GetExtChar (Standard_IStream& IS, Standard_ExtCharacter& theValue);
64   
65   //! Writes <theShape> on <theStream> in binary format.
66   Standard_EXPORT static void Write (const TopoDS_Shape& theShape, Standard_OStream& theStream);
67   
68   //! Reads a shape from <theStream> and returns it in <theShape>.
69   Standard_EXPORT static void Read (TopoDS_Shape& theShape, Standard_IStream& theStream);
70   
71   //! Writes <theShape> in <theFile>.
72   Standard_EXPORT static Standard_Boolean Write (const TopoDS_Shape& theShape, const Standard_CString theFile);
73   
74   //! Reads a shape from <theFile> and returns it in <theShape>.
75   Standard_EXPORT static Standard_Boolean Read (TopoDS_Shape& theShape, const Standard_CString theFile);
76
77 protected:
78
79
80
81
82
83 private:
84
85
86
87
88 friend class BinTools_ShapeSet;
89 friend class BinTools_Curve2dSet;
90 friend class BinTools_CurveSet;
91 friend class BinTools_SurfaceSet;
92 friend class BinTools_LocationSet;
93
94 };
95
96
97
98
99
100
101
102 #endif // _BinTools_HeaderFile