CR32614 Coding - get rid of unsused forward declarations [Adaptor2d to GccAna]
[occt.git] / src / BinTools / BinTools_LocationSet.hxx
CommitLineData
42cf5bc1 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>
42cf5bc1 27class TopLoc_Location;
28
d5c71e20 29//! Operator for writing transformation into the stream
30Standard_OStream& operator << (Standard_OStream& OS, const gp_Trsf& T);
42cf5bc1 31
32//! The class LocationSet stores a set of location in
33//! a relocatable state.
34//!
35//! It can be created from Locations.
36//!
37//! It can create Locations.
38class BinTools_LocationSet
39{
40public:
41
42 DEFINE_STANDARD_ALLOC
43
44
45 //! Returns an empty set of locations.
46 Standard_EXPORT BinTools_LocationSet();
47
48 //! Clears the content of the set.
49 Standard_EXPORT void Clear();
50
51 //! Incorporate a new Location in the set and returns
52 //! its index.
53 Standard_EXPORT Standard_Integer Add (const TopLoc_Location& L);
54
55 //! Returns the location of index <I>.
56 Standard_EXPORT const TopLoc_Location& Location (const Standard_Integer I) const;
57
58 //! Returns the index of <L>.
59 Standard_EXPORT Standard_Integer Index (const TopLoc_Location& L) const;
60
61 //! Returns number of locations.
62 Standard_EXPORT Standard_Integer NbLocations() const;
63
64 //! Writes the content of me on the stream <OS> in a
65 //! format that can be read back by Read.
66 Standard_EXPORT void Write (Standard_OStream& OS) const;
67
68 //! Reads the content of me from the stream <IS>. me
69 //! is first cleared.
70 Standard_EXPORT void Read (Standard_IStream& IS);
71
42cf5bc1 72protected:
73
74
75
76
77
78private:
79
80
81
82 TopLoc_IndexedMapOfLocation myMap;
83
84
85};
86
87
88
89
90
91
92
93#endif // _BinTools_LocationSet_HeaderFile