src/GEOMAlgo/GEOMAlgo_ShapeSet.cdl

   1 -- Copyright (C) 2005  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   2 -- CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   3 --
   4 -- This library is free software; you can redistribute it and/or
   5 -- modify it under the terms of the GNU Lesser General Public
   6 -- License as published by the Free Software Foundation; either
   7 -- version 2.1 of the License.
   8 --
   9 -- This library is distributed in the hope that it will be useful
  10 -- but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 -- Lesser General Public License for more details.
  13 --
  14 -- You should have received a copy of the GNU Lesser General Public
  15 -- License along with this library; if not, write to the Free Software
  16 -- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 --
  18 -- See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  19 --
  20 -- File:        GEOMAlgo_ShapeSet.cdl
  21 -- Created:
  22 -- Author:      Peter KURNEV
  23
  24 class ShapeSet from GEOMAlgo
  25
  26         ---Purpose: Implementation some formal
  27         --          opereations with Set of shapes
  28
  29 uses
  30     Shape from TopoDS,
  31     MapOfOrientedShape from TopTools,
  32     ListOfShape from TopTools,
  33     ShapeEnum from TopAbs
  34
  35 --raises
  36
  37 is
  38     Create
  39         ---Purpose: Empty constructor
  40         returns ShapeSet from GEOMAlgo;
  41
  42     Add(me:out;
  43             theLS:ListOfShape from TopTools);
  44         ---Purpose: Adds shapes from the list theLS to the Set
  45
  46     Add(me:out;
  47             theShape:Shape from TopoDS);
  48         ---Purpose: Adds shape theShape to the Set
  49
  50     Add(me:out;
  51             theShape:Shape from TopoDS;
  52             theType :ShapeEnum from TopAbs);
  53         ---Purpose: Adds sub-shapes of shape theShape,
  54         --          that have type theType to the Set
  55
  56     Subtract(me:out;
  57             theSet:ShapeSet from GEOMAlgo);
  58         ---Purpose: Removes shapes of theSet from the Set
  59
  60     Clear(me:out);
  61         ---Purpose: Clears internal fields
  62
  63     Contains(me;
  64             theSet:ShapeSet from GEOMAlgo)
  65         ---Purpose: Returns True if the Set contains
  66         --          all shapes of theSet
  67         returns Boolean from Standard;
  68
  69     GetSet(me)
  70         ---Purpose: Returns the Set
  71         returns ListOfShape from TopTools;
  72     ---C++: return const &
  73
  74 fields
  75     myMap  : MapOfOrientedShape from TopTools is protected;
  76     myList : ListOfShape        from TopTools is protected;
  77
  78 end ShapeSet;