src/GEOMAlgo/GEOMAlgo_ShapeSet.cdl

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