0023024: Update headers of OCCT files
[occt.git] / src / BOP / BOP_WireSolid.cdl
1 -- Created on: 2002-02-04
2 -- Created by: Peter KURNEV
3 -- Copyright (c) 2002-2012 OPEN CASCADE SAS
4 --
5 -- The content of this file is subject to the Open CASCADE Technology Public
6 -- License Version 6.5 (the "License"). You may not use the content of this file
7 -- except in compliance with the License. Please obtain a copy of the License
8 -- at http://www.opencascade.org and read it completely before using this file.
9 --
10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
12 --
13 -- The Original Code and all software distributed under the License is
14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
15 -- Initial Developer hereby disclaims all such warranties, including without
16 -- limitation, any warranties of merchantability, fitness for a particular
17 -- purpose or non-infringement. Please see the License for the specific terms
18 -- and conditions governing the rights and limitations under the License.
19
20
21
22 class WireSolid from BOP inherits WireShape from BOP
23
24         ---Purpose:  
25         --  The class is to perform a Boolean Operations (BO)       
26         --  Common,Cut,Fuse  between arguments when one of them is  
27         --  a wire and other argument is a solid 
28         --       
29
30 uses
31     DSFiller  from BOPTools, 
32     PDSFiller from BOPTools, 
33     HistoryCollector from BOP,
34     --modified by NIZHNY-MKK  Tue Sep  7 11:42:36 2004
35     ShapeEnum        from TopAbs,
36     Operation        from BOP,
37     ListOfShape from TopTools 
38
39
40 is
41     Create   
42         returns  WireSolid from BOP; 
43         ---Purpose:  
44         --- Empty constructor;
45         ---
46     Do  (me:out) 
47         is  redefined;   
48         ---Purpose:  
49         --- (See base classes, please)
50         ---
51     DoWithFiller      (me:out; 
52              aDSF: DSFiller from BOPTools) 
53         is  redefined; 
54         ---Purpose:  
55         --- (See base classes, please) 
56         ---
57     Destroy (me: in out) 
58         is redefined; 
59         ---C++: alias "Standard_EXPORT virtual ~BOP_WireSolid(){Destroy();}"  
60         ---Purpose:  
61         --- Destructor 
62         ---
63     BuildResult (me:out) 
64         is  redefined;   
65         ---Purpose:  
66         --- (See base classes, please) 
67         ---
68     --modified by NIZHNY-MKK  Tue Sep  7 11:41:46 2004
69     CheckArgTypes(myclass; theType1, theType2: ShapeEnum from TopAbs;
70                            theOperation: Operation from BOP) 
71          returns Boolean from Standard;  
72         ---Purpose: 
73         --- Check the types of arguments.      
74         --- Returns  FALSE if types of arguments     
75         --- are non-valid to be  treated by the         
76         --- agorithm
77         
78     CheckArgTypes(me) 
79         returns Boolean from Standard 
80         is  private;  
81         ---Purpose:  
82         --- Internal  usage
83         ---
84     AddSplitParts(me:out)   
85         is  private;     
86         ---Purpose:  
87         --- Internal  usage
88         ---
89
90     SetHistoryCollector(me: in out; theHistory: HistoryCollector from BOP)
91         is redefined virtual;
92
93 --fields
94      
95 end WireSolid;