src/TopTools/TopTools_LocationSet.hxx

   1 // Created on: 1993-07-16
   2 // Created by: Remi LEQUETTE
   3 // Copyright (c) 1993-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _TopTools_LocationSet_HeaderFile
  18 #define _TopTools_LocationSet_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <TopLoc_IndexedMapOfLocation.hxx>
  25 #include <Standard_Integer.hxx>
  26 #include <Standard_OStream.hxx>
  27 #include <Standard_IStream.hxx>
  28 #include <Message_ProgressRange.hxx>
  29
  30 class Standard_OutOfRange;
  31 class TopLoc_Location;
  32
  33
  34 //! The class LocationSet stores a set of location in
  35 //! a relocatable state.
  36 //!
  37 //! It can be created from Locations.
  38 //!
  39 //! It can create Locations.
  40 //!
  41 //! It can be write and read from a stream.
  42 class TopTools_LocationSet
  43 {
  44 public:
  45
  46   DEFINE_STANDARD_ALLOC
  47
  48
  49   //! Returns an empty set of locations.
  50   Standard_EXPORT TopTools_LocationSet();
  51
  52   //! Clears the content of the set.
  53   Standard_EXPORT void Clear();
  54
  55   //! Incorporate a new Location in the  set and returns
  56   //! its index.
  57   Standard_EXPORT Standard_Integer Add (const TopLoc_Location& L);
  58
  59   //! Returns the location of index <I>.
  60   Standard_EXPORT const TopLoc_Location& Location (const Standard_Integer I) const;
  61
  62   //! Returns the index of <L>.
  63   Standard_EXPORT Standard_Integer Index (const TopLoc_Location& L) const;
  64
  65   //! Dumps the content of me on the stream <OS>.
  66   Standard_EXPORT void Dump (Standard_OStream& OS) const;
  67
  68   //! Writes the content of  me  on the stream <OS> in a
  69   //! format that can be read back by Read.
  70   Standard_EXPORT void Write (Standard_OStream& OS,
  71                               const Message_ProgressRange& theProgress = Message_ProgressRange()) const;
  72
  73   //! Reads the content of me from the  stream  <IS>. me
  74   //! is first cleared.
  75   Standard_EXPORT void Read (Standard_IStream& IS,
  76                              const Message_ProgressRange& theProgress = Message_ProgressRange());
  77
  78 private:
  79
  80   TopLoc_IndexedMapOfLocation myMap;
  81 };
  82
  83 #endif // _TopTools_LocationSet_HeaderFile