src/GeomTools/GeomTools_SurfaceSet.hxx

   1 // Created on: 1993-07-19
   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 _GeomTools_SurfaceSet_HeaderFile
  18 #define _GeomTools_SurfaceSet_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <TColStd_IndexedMapOfTransient.hxx>
  25 #include <Standard_Integer.hxx>
  26 #include <Standard_OStream.hxx>
  27 #include <Standard_IStream.hxx>
  28 #include <Message_ProgressRange.hxx>
  29
  30 class Geom_Surface;
  31
  32
  33 //! Stores a set of Surfaces from Geom.
  34 class GeomTools_SurfaceSet
  35 {
  36 public:
  37
  38   DEFINE_STANDARD_ALLOC
  39
  40
  41   //! Returns an empty set of Surfaces.
  42   Standard_EXPORT GeomTools_SurfaceSet();
  43
  44   //! Clears the content of the set.
  45   Standard_EXPORT void Clear();
  46
  47   //! Incorporate a new Surface in the  set and returns
  48   //! its index.
  49   Standard_EXPORT Standard_Integer Add (const Handle(Geom_Surface)& S);
  50
  51   //! Returns the Surface of index <I>.
  52   Standard_EXPORT Handle(Geom_Surface) Surface (const Standard_Integer I) const;
  53
  54   //! Returns the index of <L>.
  55   Standard_EXPORT Standard_Integer Index (const Handle(Geom_Surface)& S) const;
  56
  57   //! Dumps the content of me on the stream <OS>.
  58   Standard_EXPORT void Dump (Standard_OStream& OS) const;
  59
  60   //! Writes the content of  me  on the stream <OS> in a
  61   //! format that can be read back by Read.
  62   Standard_EXPORT void Write (Standard_OStream& OS,
  63                               const Message_ProgressRange& theProgress = Message_ProgressRange()) const;
  64
  65   //! Reads the content of me from the  stream  <IS>. me
  66   //! is first cleared.
  67   Standard_EXPORT void Read (Standard_IStream& IS,
  68                              const Message_ProgressRange& theProgress = Message_ProgressRange());
  69
  70   //! Dumps the surface on the stream,  if compact is True
  71   //! use the compact format that can be read back.
  72   Standard_EXPORT static void PrintSurface (const Handle(Geom_Surface)& S,
  73                                             Standard_OStream& OS,
  74                                             const Standard_Boolean compact = Standard_False);
  75
  76   //! Reads the surface  from  the stream.  The  surface  is
  77   //! assumed   to have  been  written  with  the Print
  78   //! method (compact = True).
  79   Standard_EXPORT static Handle(Geom_Surface) ReadSurface (Standard_IStream& IS);
  80
  81 private:
  82
  83   TColStd_IndexedMapOfTransient myMap;
  84
  85 };
  86
  87 #endif // _GeomTools_SurfaceSet_HeaderFile