src/GEOMAlgo/GEOMAlgo_BuilderShape.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_BuilderShape.cdl
  24 -- Created:
  25 -- Author:      Peter KURNEV
  26 --
  27 deferred class BuilderShape from GEOMAlgo
  28         inherits Algo from GEOMAlgo
  29
  30         ---Purpose: Root class for algorithms that has shape as result
  31
  32 uses
  33     Shape from TopoDS,
  34     ListOfShape from TopTools,
  35     MapOfShape  from TopTools,
  36     IndexedDataMapOfShapeListOfShape from TopTools
  37
  38 --raises
  39
  40 is
  41     Initialize
  42         ---Purpose: Empty constructor
  43         returns BuilderShape from GEOMAlgo;
  44     ---C++: alias "Standard_EXPORT virtual ~GEOMAlgo_BuilderShape();"
  45
  46     Shape(me)
  47         ---Purpose:  Returns the result of algorithm
  48         returns Shape from TopoDS;
  49     ---C++: return const &
  50
  51
  52     ------------------------------------------------------------------
  53     --- The following methods are not implemented at this level.
  54     --  An empty list is returned.
  55     --- They are optional and can be redefined.
  56     ------------------------------------------------------------------
  57     Generated (me:out;
  58             theS : Shape from TopoDS)
  59         ---Purpose: Returns the list of shapes generated from the
  60         --          shape theS.
  61         returns ListOfShape from TopTools
  62         is virtual;
  63         ---C++: return const &
  64
  65     Modified (me:out;
  66             theS : Shape from TopoDS)
  67         ---Purpose: Returns the list of shapes modified from the
  68         --          shape theS.
  69         returns ListOfShape from TopTools
  70         is virtual;
  71         ---C++: return const &
  72
  73     IsDeleted (me:out;
  74             theS : Shape from TopoDS)
  75         ---Purpose: Returns true if the shape theS has been deleted.
  76         returns Boolean from Standard
  77         is virtual;
  78
  79     HasDeleted (me)
  80         ---Purpose: Returns true if the at least one shape(or subshape)
  81         --          of arguments has been deleted.
  82         returns Boolean from Standard;
  83
  84     HasGenerated (me)
  85         ---Purpose: Returns true if the at least one shape(or subshape)
  86         --          of arguments has generated shapes.
  87         returns Boolean from Standard;
  88
  89     HasModified (me)
  90         ---Purpose: Returns true if the at least one shape(or subshape)
  91         --          of arguments has modified shapes.
  92         returns Boolean from Standard;
  93
  94     PrepareHistory (me:out)
  95         ---Purpose:  Prepare information for history support
  96         is virtual protected;
  97
  98 --modified by NIZNHY-PKV Thu Dec  7 11:13:17 2006f
  99     ImagesResult(me)
 100          returns IndexedDataMapOfShapeListOfShape from TopTools;
 101     ---C++: return const &
 102 --modified by NIZNHY-PKV Thu Dec  7 11:13:20 2006t
 103 fields
 104     myShape      : Shape from TopoDS is protected;
 105     --
 106     myHistShapes   : ListOfShape from TopTools is protected;
 107     myMapShape     : MapOfShape  from TopTools is protected;
 108     myHasDeleted   : Boolean     from Standard is protected;
 109     myHasGenerated : Boolean     from Standard is protected;
 110     myHasModified  : Boolean     from Standard is protected;
 111 --modified by NIZNHY-PKV Thu Dec  7 11:13:10 2006f
 112     myImagesResult : IndexedDataMapOfShapeListOfShape from TopTools is protected;
 113 --modified by NIZNHY-PKV Thu Dec  7 11:13:13 2006t
 114 end BuilderShape;
 115