Salome HOME
Update copyright
[modules/geom.git] / src / GEOMAlgo / GEOMAlgo_WESCorrector.cdl
1 -- Copyright (C) 2007-2011  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
23 -- File:        GEOMAlgo_WESCorrector.cdl
24 -- Created:     
25 -- Author:      Peter KURNEV
26 --
27 class WESCorrector from GEOMAlgo  
28     inherits Algo from GEOMAlgo
29
30         ---Purpose: 
31         ---  The algorithm to change the Wire Edges Set (WES) contents.
32         --   The NewWES will contain only wires instead of wires and edges. 
33         --
34 uses
35     WireEdgeSet          from GEOMAlgo,
36     PWireEdgeSet         from GEOMAlgo,
37     ListOfConnexityBlock from BOP 
38     
39 is 
40     Create   
41         returns WESCorrector from GEOMAlgo; 
42     ---C++: alias "Standard_EXPORT virtual ~GEOMAlgo_WESCorrector();"  
43     ---Purpose:  
44     -- Empty constructor; 
45     -- 
46     
47     SetWES  (me:out; 
48                 aWES: WireEdgeSet from GEOMAlgo);  
49     ---Purpose: 
50     -- Modifier 
51     --
52     Perform (me:out) 
53         is redefined; 
54     ---Purpose: 
55     --- Performs the algorithm that  consists  of  two  steps 
56     --- 1. Make conexity blocks (  DoConnexityBlocks()  )     
57     --- 2. Make corrections     (  DoCorrections()  )        
58     ---
59       
60     WES     (me:out) 
61         returns WireEdgeSet from GEOMAlgo; 
62     ---C++:  return &  
63     ---Purpose: 
64     --- Selector 
65     ---
66     NewWES  (me:out) 
67         returns WireEdgeSet from GEOMAlgo; 
68     ---C++:  return &   
69     ---Purpose: 
70     --- Selector 
71     ---
72     DoConnexityBlocks(me:out) 
73         is protected; 
74        
75     DoCorrections(me:out) 
76         is protected; 
77
78 fields 
79
80     myWES             : PWireEdgeSet         from GEOMAlgo is protected; 
81     myNewWES          : WireEdgeSet          from GEOMAlgo is protected;  
82     myConnexityBlocks : ListOfConnexityBlock from BOP is protected;  
83
84 end WESCorrector;