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