1 // Created on: 2004-05-11
2 // Created by: Sergey ZARITCHNY <szy@opencascade.com>
3 // Copyright (c) 2004-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
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.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 #ifndef _BinTools_HeaderFile
17 #define _BinTools_HeaderFile
19 #include <Standard.hxx>
20 #include <Standard_DefineAlloc.hxx>
21 #include <Standard_Handle.hxx>
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_ProgressIndicator.hxx>
32 class BinTools_ShapeSet;
33 class BinTools_Curve2dSet;
34 class BinTools_CurveSet;
35 class BinTools_SurfaceSet;
36 class BinTools_LocationSet;
39 //! Tool to keep shapes in binary format
46 Standard_EXPORT static Standard_OStream& PutReal (Standard_OStream& OS, const Standard_Real& theValue);
48 Standard_EXPORT static Standard_OStream& PutShortReal (Standard_OStream& OS, const Standard_ShortReal& theValue);
50 Standard_EXPORT static Standard_OStream& PutInteger (Standard_OStream& OS, const Standard_Integer theValue);
52 Standard_EXPORT static Standard_OStream& PutBool (Standard_OStream& OS, const Standard_Boolean theValue);
54 Standard_EXPORT static Standard_OStream& PutExtChar (Standard_OStream& OS, const Standard_ExtCharacter theValue);
56 Standard_EXPORT static Standard_IStream& GetReal (Standard_IStream& IS, Standard_Real& theValue);
58 Standard_EXPORT static Standard_IStream& GetShortReal (Standard_IStream& IS, Standard_ShortReal& theValue);
60 Standard_EXPORT static Standard_IStream& GetInteger (Standard_IStream& IS, Standard_Integer& theValue);
62 Standard_EXPORT static Standard_IStream& GetBool (Standard_IStream& IS, Standard_Boolean& theValue);
64 Standard_EXPORT static Standard_IStream& GetExtChar (Standard_IStream& IS, Standard_ExtCharacter& theValue);
66 //! Writes <theShape> on <theStream> in binary format.
67 Standard_EXPORT static void Write (const TopoDS_Shape& theShape, Standard_OStream& theStream,
68 const Handle(Message_ProgressIndicator)& theProgress = NULL);
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 Handle(Message_ProgressIndicator)& theProgress = NULL);
74 //! Writes <theShape> in <theFile>.
75 Standard_EXPORT static Standard_Boolean Write
76 (const TopoDS_Shape& theShape, const Standard_CString theFile,
77 const Handle(Message_ProgressIndicator)& theProgress = NULL);
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 Handle(Message_ProgressIndicator)& theProgress = NULL);
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;
109 #endif // _BinTools_HeaderFile