src/GEOMAlgo_NEW/GEOMAlgo_ShapeSet.hxx

   1 // Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 // File:        GEOMAlgo_ShapeSet.hxx
  24 // Created:
  25 // Author:      Peter KURNEV
  26 //
  27 #ifndef _GEOMAlgo_ShapeSet_HeaderFile
  28 #define _GEOMAlgo_ShapeSet_HeaderFile
  29
  30 #include <Standard.hxx>
  31 #include <Standard_Macro.hxx>
  32 #include <TopTools_MapOfOrientedShape.hxx>
  33 #include <TopTools_ListOfShape.hxx>
  34 #include <TopAbs_ShapeEnum.hxx>
  35 #include <Standard_Boolean.hxx>
  36 #include <TopoDS_Shape.hxx>
  37
  38 //! Implementation some formal <br>
  39 //!          opereations with Set of shapes <br>
  40 //=======================================================================
  41 //class    : GEOMAlgo_ShapeSet
  42 //purpose  :
  43 //=======================================================================
  44 class GEOMAlgo_ShapeSet
  45 {
  46  public:
  47   //! Empty constructor <br>
  48   Standard_EXPORT
  49     GEOMAlgo_ShapeSet();
  50
  51   //! Adds shapes from the list theLS to the Set <br>
  52   Standard_EXPORT
  53     void Add(const TopTools_ListOfShape& theLS) ;
  54
  55   //! Adds shape theShape to the Set <br>
  56   Standard_EXPORT
  57     void Add(const TopoDS_Shape& theShape) ;
  58
  59   //! Adds sub-shapes of shape theShape, <br>
  60   //!          that have type theType to the Set <br>
  61   Standard_EXPORT
  62     void Add(const TopoDS_Shape& theShape,const TopAbs_ShapeEnum theType) ;
  63
  64   //! Removes shapes of theSet from the Set <br>
  65   Standard_EXPORT
  66     void Subtract(const GEOMAlgo_ShapeSet& theSet) ;
  67
  68   //! Clears internal fields <br>
  69   Standard_EXPORT     void Clear() ;
  70
  71   //! Returns True if the Set contains <br>
  72   //!          all shapes of theSet <br>
  73   Standard_EXPORT
  74     Standard_Boolean Contains(const GEOMAlgo_ShapeSet& theSet) const;
  75
  76   //! Returns the Set <br>
  77   Standard_EXPORT
  78     const TopTools_ListOfShape& GetSet() const;
  79
  80   //! Returns True if the Set==theSet <br>
  81   Standard_EXPORT
  82     Standard_Boolean IsEqual(const GEOMAlgo_ShapeSet& theOther) const;
  83
  84   Standard_Boolean operator ==(const GEOMAlgo_ShapeSet& theOther) const {
  85     return IsEqual(theOther);
  86   }
  87
  88  protected:
  89   TopTools_MapOfOrientedShape myMap;
  90   TopTools_ListOfShape myList;
  91 };
  92 #endif