0023024: Update headers of OCCT files
[occt.git] / src / BRepFeat / BRepFeat_Builder.cdl
1 -- Created on: 1995-06-13
2 -- Created by: Jacques GOUSSARD
3 -- Copyright (c) 1995-1999 Matra Datavision
4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
5 --
6 -- The content of this file is subject to the Open CASCADE Technology Public
7 -- License Version 6.5 (the "License"). You may not use the content of this file
8 -- except in compliance with the License. Please obtain a copy of the License
9 -- at http://www.opencascade.org and read it completely before using this file.
10 --
11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13 --
14 -- The Original Code and all software distributed under the License is
15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
16 -- Initial Developer hereby disclaims all such warranties, including without
17 -- limitation, any warranties of merchantability, fitness for a particular
18 -- purpose or non-infringement. Please see the License for the specific terms
19 -- and conditions governing the rights and limitations under the License.
20
21
22
23 deferred class Builder from BRepFeat inherits MakeShape from BRepBuilderAPI
24
25         ---Purpose: Provides  the   implementation  of  all    methods
26         --          required by BRepCtx for class using a Builder from
27         --          LocOpe.  All  features have  to inherit  from this
28         --          class. 
29
30 uses 
31     Builder           from LocOpe,
32     Shape             from TopoDS,
33     Face              from TopoDS,
34     Edge              from TopoDS,
35     MapOfShape        from TopTools,
36     ListOfShape       from TopTools,
37     ShapeModification from BRepBuilderAPI
38
39 raises
40     NotDone           from StdFail,
41     ConstructionError from Standard
42
43 is
44
45     Initialize;
46         ---Purpose: Empty constructor.
47         ---C++: inline
48         
49         
50     Initialize(S: Shape from TopoDS)
51         ---Purpose: Creates a local operation on <S>.
52         ---C++: inline
53         -- Raises ConstructionError  if <S> is a null shape.
54         raises ConstructionError from Standard;
55
56
57     Initialize(S,T: Shape from TopoDS)
58         ---Purpose: Creates a local operation between <S> and <T>.
59         ---C++: inline
60         -- Raises ConstructionError if <S> is a null shape
61         raises ConstructionError from Standard;
62
63
64     Init(me: in out; S: Shape from TopoDS)
65         ---Purpose: Initializes a local operation on <S>.
66         ---C++: inline
67         raises ConstructionError from Standard
68         --- The exception is raised if <S> is a null shape.
69         is static;
70
71     Init(me: in out; S,T: Shape from TopoDS)
72         ---Purpose: Initializes a local operation between <S> and <T>.
73         -- Raises ConstructionError if <S> is a null shape.
74         ---C++: inline
75         raises ConstructionError from Standard
76         is static;
77
78
79
80 --- Methods inherited from MakeShape, that must be redefined.
81
82     Modified(me: in out; F: Shape from TopoDS)
83         ---Purpose: Returns the list of generated Faces.
84         ---C++:     return const & 
85     returns ListOfShape from TopTools
86     is redefined static;
87     
88 fields
89
90     myBuilder : Builder    from LocOpe   is protected;
91     myMap     : MapOfShape from TopTools is protected;
92     myGenFaces: ListOfShape from TopTools is protected;
93 end Builder;