src/GEOMAlgo/GEOMAlgo_ShapeSet.cdl

   1 --  Copyright (C) 2007-2008  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 -- File:        GEOMAlgo_ShapeSet.cdl
  23 -- Created:
  24 -- Author:      Peter KURNEV
  25 --
  26 class ShapeSet from GEOMAlgo
  27
  28         ---Purpose: Implementation some formal
  29         --          opereations with Set of shapes
  30
  31 uses
  32     Shape from TopoDS,
  33     MapOfOrientedShape from TopTools,
  34     ListOfShape from TopTools,
  35     ShapeEnum from TopAbs
  36
  37 --raises
  38
  39 is
  40     Create
  41         ---Purpose: Empty constructor
  42         returns ShapeSet from GEOMAlgo;
  43
  44     Add(me:out;
  45             theLS:ListOfShape from TopTools);
  46         ---Purpose: Adds shapes from the list theLS to the Set
  47
  48     Add(me:out;
  49             theShape:Shape from TopoDS);
  50         ---Purpose: Adds shape theShape to the Set
  51
  52     Add(me:out;
  53             theShape:Shape from TopoDS;
  54             theType :ShapeEnum from TopAbs);
  55         ---Purpose: Adds sub-shapes of shape theShape,
  56         --          that have type theType to the Set
  57
  58     Subtract(me:out;
  59             theSet:ShapeSet from GEOMAlgo);
  60         ---Purpose: Removes shapes of theSet from the Set
  61
  62     Clear(me:out);
  63         ---Purpose: Clears internal fields
  64
  65     Contains(me;
  66             theSet:ShapeSet from GEOMAlgo)
  67         ---Purpose: Returns True if the Set contains
  68         --          all shapes of theSet
  69         returns Boolean from Standard;
  70
  71     GetSet(me)
  72         ---Purpose: Returns the Set
  73         returns ListOfShape from TopTools;
  74     ---C++: return const &
  75
  76 fields
  77     myMap  : MapOfOrientedShape from TopTools is protected;
  78     myList : ListOfShape        from TopTools is protected;
  79
  80 end ShapeSet;