0031918: Application Framework - New binary format for fast reading part of OCAF...
[occt.git] / src / BinTools / BinTools_LocationSet.hxx
1 // Created on: 2004-06-15
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_LocationSet_HeaderFile
17 #define _BinTools_LocationSet_HeaderFile
18
19 #include <Standard.hxx>
20 #include <Standard_DefineAlloc.hxx>
21 #include <Standard_Handle.hxx>
22
23 #include <TopLoc_IndexedMapOfLocation.hxx>
24 #include <Standard_Integer.hxx>
25 #include <Standard_OStream.hxx>
26 #include <Standard_IStream.hxx>
27 class Standard_OutOfRange;
28 class TopLoc_Location;
29
30 //! Operator for writing transformation into the stream
31 Standard_OStream& operator << (Standard_OStream& OS, const gp_Trsf& T);
32
33 //! The class LocationSet stores a set of location in
34 //! a relocatable state.
35 //!
36 //! It can be created from Locations.
37 //!
38 //! It can create Locations.
39 class BinTools_LocationSet 
40 {
41 public:
42
43   DEFINE_STANDARD_ALLOC
44
45   
46   //! Returns an empty set of locations.
47   Standard_EXPORT BinTools_LocationSet();
48   
49   //! Clears the content of the set.
50   Standard_EXPORT void Clear();
51   
52   //! Incorporate a new Location in the  set and returns
53   //! its index.
54   Standard_EXPORT Standard_Integer Add (const TopLoc_Location& L);
55   
56   //! Returns the location of index <I>.
57   Standard_EXPORT const TopLoc_Location& Location (const Standard_Integer I) const;
58   
59   //! Returns the index of <L>.
60   Standard_EXPORT Standard_Integer Index (const TopLoc_Location& L) const;
61   
62   //! Returns number of locations.
63   Standard_EXPORT Standard_Integer NbLocations() const;
64   
65   //! Writes the content of  me  on the stream <OS> in a
66   //! format that can be read back by Read.
67   Standard_EXPORT void Write (Standard_OStream& OS) const;
68   
69   //! Reads the content of me from the  stream  <IS>. me
70   //! is first cleared.
71   Standard_EXPORT void Read (Standard_IStream& IS);
72
73 protected:
74
75
76
77
78
79 private:
80
81
82
83   TopLoc_IndexedMapOfLocation myMap;
84
85
86 };
87
88
89
90
91
92
93
94 #endif // _BinTools_LocationSet_HeaderFile