Salome HOME
Join modifications from BR_Dev_For_4_0 tag V4_1_1.
[modules/geom.git] / src / GEOMAlgo / GEOMAlgo_WESCorrector.cdl
1 -- Copyright (C) 2005  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
2 -- CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
3 -- 
4 -- This library is free software; you can redistribute it and/or
5 -- modify it under the terms of the GNU Lesser General Public
6 -- License as published by the Free Software Foundation; either 
7 -- version 2.1 of the License.
8 -- 
9 -- This library is distributed in the hope that it will be useful 
10 -- but WITHOUT ANY WARRANTY; without even the implied warranty of 
11 -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
12 -- Lesser General Public License for more details.
13 --
14 -- You should have received a copy of the GNU Lesser General Public  
15 -- License along with this library; if not, write to the Free Software 
16 -- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
17 --
18 -- See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 -- 
20 -- File:        GEOMAlgo_WESCorrector.cdl
21 -- Created:     
22 -- Author:      Peter KURNEV
23
24
25 class WESCorrector from GEOMAlgo  
26     inherits Algo from GEOMAlgo
27
28         ---Purpose: 
29         ---  The algorithm to change the Wire Edges Set (WES) contents.
30         --   The NewWES will contain only wires instead of wires and edges. 
31         --
32 uses
33     WireEdgeSet          from GEOMAlgo,
34     PWireEdgeSet         from GEOMAlgo,
35     ListOfConnexityBlock from BOP 
36     
37 is 
38     Create   
39         returns WESCorrector from GEOMAlgo; 
40     ---C++: alias "Standard_EXPORT virtual ~GEOMAlgo_WESCorrector();"  
41     ---Purpose:  
42     -- Empty constructor; 
43     -- 
44     
45     SetWES  (me:out; 
46                 aWES: WireEdgeSet from GEOMAlgo);  
47     ---Purpose: 
48     -- Modifier 
49     --
50     Perform (me:out) 
51         is redefined; 
52     ---Purpose: 
53     --- Performs the algorithm that  consists  of  two  steps 
54     --- 1. Make conexity blocks (  DoConnexityBlocks()  )     
55     --- 2. Make corrections     (  DoCorrections()  )        
56     ---
57       
58     WES     (me:out) 
59         returns WireEdgeSet from GEOMAlgo; 
60     ---C++:  return &  
61     ---Purpose: 
62     --- Selector 
63     ---
64     NewWES  (me:out) 
65         returns WireEdgeSet from GEOMAlgo; 
66     ---C++:  return &   
67     ---Purpose: 
68     --- Selector 
69     ---
70     DoConnexityBlocks(me:out) 
71         is protected; 
72        
73     DoCorrections(me:out) 
74         is protected; 
75
76 fields 
77
78     myWES             : PWireEdgeSet         from GEOMAlgo is protected; 
79     myNewWES          : WireEdgeSet          from GEOMAlgo is protected;  
80     myConnexityBlocks : ListOfConnexityBlock from BOP is protected;  
81
82 end WESCorrector;