Salome HOME
Fix documentation problems (reported as doxygen warnings)
[modules/geom.git] / src / GEOMAlgo / GEOMAlgo_Clsf.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_Clsf.cdl
23 -- Created:     Wed Nov 22 10:19:29 2006
24 -- Author:      Peter KURNEV
25 --              <pkv@irinox>
26 --
27 deferred class Clsf from GEOMAlgo 
28     inherits HAlgo from GEOMAlgo 
29      
30         ---Purpose: 
31
32 uses 
33     State from TopAbs,
34     Pnt from gp, 
35     Curve from Geom,
36     Surface from Geom 
37     
38 --raises
39
40 is 
41     Initialize 
42         returns mutable Clsf from GEOMAlgo; 
43     ---C++: alias "Standard_EXPORT virtual ~GEOMAlgo_Clsf();"  
44      
45     SetPnt(me:mutable; 
46             aP:Pnt from gp); 
47              
48     Pnt(me) 
49         returns Pnt from gp; 
50     ---C++:return const&         
51          
52     SetTolerance(me:mutable; 
53             aT:Real from Standard);  
54          
55     Tolerance(me) 
56         returns Real from Standard;       
57          
58     State(me) 
59         returns State from TopAbs; 
60          
61     CanBeON(me; 
62             aCT:Curve from Geom) 
63         returns Boolean from Standard 
64         is virtual;     
65
66     CanBeON(me; 
67             aST:Surface from Geom) 
68         returns Boolean from Standard 
69         is virtual;     
70         
71 fields 
72     myState    :State from TopAbs is protected;
73     myPnt      :Pnt from gp is protected;
74     myTolerance:Real from Standard is protected; 
75
76 end Clsf;