Salome HOME
Fix documentation problems (reported as doxygen warnings)
[modules/geom.git] / src / GEOMAlgo / GEOMAlgo_ClsfBox.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_ClsfBox.cdl
23 -- Created:     Wed Nov 22 10:19:29 2006
24 -- Author:      Peter KURNEV
25 --              <pkv@irinox>
26 --
27 class ClsfBox from GEOMAlgo 
28     inherits Clsf from GEOMAlgo 
29      
30         ---Purpose: 
31
32 uses 
33     Shape from TopoDS, 
34     Curve   from Geom, 
35     Surface from Geom,
36     Surface from GeomAdaptor
37
38 --raises
39
40 is 
41     Create 
42         returns mutable ClsfBox from GEOMAlgo; 
43     ---C++: alias "Standard_EXPORT virtual ~GEOMAlgo_ClsfBox();"  
44       
45     SetBox(me:mutable; 
46             aS:Shape from TopoDS);  
47          
48     Box(me) 
49         returns Shape from TopoDS; 
50     ---C++: return const &     
51      
52     Perform(me:mutable) 
53         is redefined;      
54
55     CheckData(me:mutable) 
56         is redefined;  
57          
58     CanBeON(me; 
59             aC:Curve from Geom) 
60         returns Boolean from Standard 
61         is redefined;  
62      
63     CanBeON(me; 
64             aST:Surface from Geom) 
65         returns Boolean from Standard 
66         is redefined;   
67     
68 fields 
69     myBox : Shape from TopoDS is protected; 
70     myGAS : Surface from GeomAdaptor [6] is protected;
71 end ClsfBox;