Salome HOME
Change comments style in geompy.py for right processing with HappyDoc
[modules/geom.git] / src / GEOMAlgo / GEOMAlgo_FinderShapeOn.cdl
1 -- File:        GEOMAlgo_FinderShapeOn.cdl
2 -- Created:     Tue Jan 11 14:35:52 2005
3 -- Author:      Peter KURNEV
4 --              <pkv@irinox>
5 ---Copyright:    Matra Datavision 2005
6
7
8 class FinderShapeOn from GEOMAlgo 
9     inherits ShapeAlgo from GEOMAlgo 
10     
11         ---Purpose: 
12
13 uses
14     Surface from Geom, 
15     ShapeEnum from TopAbs, 
16     ListOfShape from TopTools, 
17     DataMapOfShapeShape from TopTools, 
18     Shape from TopoDS, 
19     State from GEOMAlgo
20     
21 --raises
22
23 is 
24     Create   
25         returns FinderShapeOn from GEOMAlgo; 
26     ---C++: alias "Standard_EXPORT virtual ~GEOMAlgo_FinderShapeOn();" 
27      
28     Perform(me:out) 
29         is redefined;  
30          
31     SetSurface(me:out; 
32             aS:Surface from Geom); 
33          
34     SetShapeType(me:out; 
35             aST:ShapeEnum from TopAbs); 
36          
37     SetState(me:out; 
38             aSF:State from GEOMAlgo);      
39      
40     Surface(me) 
41         returns Surface from Geom; 
42     ---C++: return const & 
43      
44     ShapeType(me) 
45         returns ShapeEnum from TopAbs; 
46          
47     State(me)
48         returns State from GEOMAlgo;  
49      
50     Shapes(me)
51         returns ListOfShape from TopTools; 
52     ---C++: return const &  
53      
54     -- 
55     --  protected  methods
56     -- 
57     CheckData(me:out) 
58         is redefined protected; 
59
60     MakeArguments(me:out) 
61         is protected;  
62
63     Find(me:out) 
64         is protected; 
65
66     CopySource(myclass; 
67         aS  :Shape from TopoDS; 
68         aImages   : out DataMapOfShapeShape from TopTools;       
69         aOriginals: out DataMapOfShapeShape from TopTools;       
70         aSC : out Shape from TopoDS); 
71         
72                                         
73
74 fields 
75     mySurface    : Surface from Geom is protected;  
76     myShapeType  : ShapeEnum from TopAbs is protected;  
77     myState      : State from GEOMAlgo is protected; 
78     myArg1       : Shape from TopoDS is protected;  
79     myArg2       : Shape from TopoDS is protected;  
80     myLS         : ListOfShape from TopTools is protected;
81     myImages     : DataMapOfShapeShape from TopTools is protected; 
82     
83 end FinderShapeOn;