0031918: Application Framework - New binary format for fast reading part of OCAF...
[occt.git] / src / BinTools / BinTools_CurveSet.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_CurveSet_HeaderFile
17 #define _BinTools_CurveSet_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_ProgressRange.hxx>
29 #include <BinTools_OStream.hxx>
30
31 class Standard_OutOfRange;
32 class Geom_Curve;
33
34
35 //! Stores a set of Curves from Geom in binary format.
36 class BinTools_CurveSet 
37 {
38 public:
39
40   DEFINE_STANDARD_ALLOC
41
42   
43   //! Returns an empty set of Curves.
44   Standard_EXPORT BinTools_CurveSet();
45   
46   //! Clears the content of the set.
47   Standard_EXPORT void Clear();
48   
49   //! Incorporate a new Curve in the  set and returns
50   //! its index.
51   Standard_EXPORT Standard_Integer Add (const Handle(Geom_Curve)& C);
52   
53   //! Returns the Curve of index <I>.
54   Standard_EXPORT Handle(Geom_Curve) Curve (const Standard_Integer I) const;
55   
56   //! Returns the index of <L>.
57   Standard_EXPORT Standard_Integer Index (const Handle(Geom_Curve)& C) const;
58   
59   //! Writes the content of  me  on the stream <OS> in a
60   //! format that can be read back by Read.
61   Standard_EXPORT void Write (Standard_OStream& OS,
62                               const Message_ProgressRange& theRange = Message_ProgressRange()) const;
63   
64   //! Reads the content of me from the  stream  <IS>. me
65   //! is first cleared.
66   Standard_EXPORT void Read (Standard_IStream& IS,
67                              const Message_ProgressRange& theRange = Message_ProgressRange());
68   
69   //! Dumps the curve on the stream in binary format
70   //! that can be read back.
71   Standard_EXPORT static void WriteCurve (const Handle(Geom_Curve)& C, BinTools_OStream& OS);
72   
73   //! Reads the curve  from  the stream.  The  curve  is
74   //! assumed  to have  been  written  with  the Write
75   //! method
76   Standard_EXPORT static Standard_IStream& ReadCurve (Standard_IStream& IS, Handle(Geom_Curve)& C);
77
78 private:
79
80   TColStd_IndexedMapOfTransient myMap;
81
82 };
83
84 #endif // _BinTools_CurveSet_HeaderFile