include/opencascade/BinTools_LocationSet.hxx

0001 // Created on: 2004-06-15
0002 // Created by: Sergey ZARITCHNY <szy@opencascade.com>
0003 // Copyright (c) 2004-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _BinTools_LocationSet_HeaderFile
0017 #define _BinTools_LocationSet_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_DefineAlloc.hxx>
0021
0022 #include <TopLoc_IndexedMapOfLocation.hxx>
0023 #include <Standard_Integer.hxx>
0024 #include <Standard_OStream.hxx>
0025 #include <Standard_IStream.hxx>
0026 class TopLoc_Location;
0027
0028 //! Operator for writing transformation into the stream
0029 Standard_OStream& operator<<(Standard_OStream& OS, const gp_Trsf& T);
0030
0031 //! The class LocationSet stores a set of location in
0032 //! a relocatable state.
0033 //!
0034 //! It can be created from Locations.
0035 //!
0036 //! It can create Locations.
0037 class BinTools_LocationSet
0038 {
0039 public:
0040   DEFINE_STANDARD_ALLOC
0041
0042   //! Returns an empty set of locations.
0043   Standard_EXPORT BinTools_LocationSet();
0044
0045   //! Clears the content of the set.
0046   Standard_EXPORT void Clear();
0047
0048   //! Incorporate a new Location in the  set and returns
0049   //! its index.
0050   Standard_EXPORT Standard_Integer Add(const TopLoc_Location& L);
0051
0052   //! Returns the location of index <I>.
0053   Standard_EXPORT const TopLoc_Location& Location(const Standard_Integer I) const;
0054
0055   //! Returns the index of <L>.
0056   Standard_EXPORT Standard_Integer Index(const TopLoc_Location& L) const;
0057
0058   //! Returns number of locations.
0059   Standard_EXPORT Standard_Integer NbLocations() const;
0060
0061   //! Writes the content of  me  on the stream <OS> in a
0062   //! format that can be read back by Read.
0063   Standard_EXPORT void Write(Standard_OStream& OS) const;
0064
0065   //! Reads the content of me from the  stream  <IS>. me
0066   //! is first cleared.
0067   Standard_EXPORT void Read(Standard_IStream& IS);
0068
0069 protected:
0070 private:
0071   TopLoc_IndexedMapOfLocation myMap;
0072 };
0073
0074 #endif // _BinTools_LocationSet_HeaderFile