0024624: Lost word in license statement in source files
[occt.git] / src / BRepSweep / BRepSweep_Tool.cdl
1 -- Created on: 1993-06-08
2 -- Created by: Laurent BOURESCHE
3 -- Copyright (c) 1993-1999 Matra Datavision
4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
5 --
6 -- This file is part of Open CASCADE Technology software library.
7 --
8 -- This library is free software; you can redistribute it and/or modify it under
9 -- the terms of the GNU Lesser General Public License version 2.1 as published
10 -- by the Free Software Foundation, with special exception defined in the file
11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 -- distribution for complete text of the license and disclaimer of any warranty.
13 --
14 -- Alternatively, this file may be used under the terms of Open CASCADE
15 -- commercial license or contractual agreement.
16
17 class Tool from BRepSweep -- as Tool from Sweep
18
19     ---Purpose: Provides  the  indexation and type  analysis  services
20     --          required by the TopoDS generating Shape of BRepSweep.
21     --          
22
23 uses
24
25     Shape from TopoDS,
26     IndexedMapOfShape from TopTools,
27     ShapeEnum from TopAbs,
28     Orientation from TopAbs
29
30 raises 
31
32     OutOfRange from Standard
33
34 is
35
36     Create(aShape: Shape from TopoDS);
37         ---Purpose: Initialize the tool  with <aShape>.  The IndexTool
38         --          must prepare an indexation for  all  the subshapes
39         --          of this shape.
40
41     NbShapes(me) returns Integer
42         ---Purpose: Returns the number of subshapes in the shape.
43     is static;
44
45     Index(me; aShape : Shape from TopoDS) returns Integer
46         ---Purpose: Returns the index of <aShape>.
47     is static;
48     
49     Shape(me; anIndex : Integer from Standard) returns Shape from TopoDS
50         ---Purpose: Returns the Shape at Index anIdex.
51     is static;
52     
53     Type(me; aShape : Shape from TopoDS) returns ShapeEnum from TopAbs
54         ---Purpose: Returns the type of <aShape>.
55     is static;
56
57     Orientation (me; aShape : Shape from TopoDS) 
58     returns Orientation from TopAbs
59         ---Purpose: Returns the Orientation of <aShape>.
60     is static;
61
62     SetOrientation (me; 
63                     aShape : in out Shape from TopoDS; 
64                     Or     : Orientation  from  TopAbs) 
65         ---Purpose: Set the Orientation of <aShape> with Or.
66     is static;
67
68 fields
69
70     myMap : IndexedMapOfShape from TopTools;
71     
72 end Tool from BRepSweep;
73
74
75