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