0024624: Lost word in license statement in source files
[occt.git] / src / BRepSweep / BRepSweep_Iterator.cdl
CommitLineData
b311480e 1-- Created on: 1993-06-08
2-- Created by: Laurent BOURESCHE
3-- Copyright (c) 1993-1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
b311480e 7--
d5f74e42 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
973c2be1 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.
b311480e 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
7fd59977 16
17class Iterator from BRepSweep
18
19 ---Purpose: This class provides iteration services required by
20 -- the Generating Line (TopoDS Shape) of a BRepSweep.
21 -- This tool is used to iterate on the direct
22 -- sub-shapes of a Shape.
23 --
24
25uses
26
27 Iterator from TopoDS,
28 Shape from TopoDS,
29 Orientation from TopAbs
30
31raises
32
33 NoMoreObject from Standard,
34 NoSuchObject from Standard
35
36is
37
38 Create;
39
40 Init(me : in out; aShape: Shape from TopoDS)
41 ---Purpose: Resest the Iterator on sub-shapes of <aShape>.
42 is static;
43
44 More(me) returns Boolean
45 ---Purpose: Returns True if there is a current sub-shape.
46 --
47 ---C++: inline
48 is static;
49
50 Next(me : in out)
51 ---Purpose: Moves to the next sub-shape.
52 raises
53 NoMoreObject from Standard
54 is static;
55
56 Value(me) returns Shape from TopoDS
57 ---Purpose: Returns the current sub-shape.
58 raises
59 NoSuchObject from Standard
60 ---C++: return const &
61 ---C++: inline
62 is static;
63
64 Orientation(me) returns Orientation from TopAbs
65 ---Purpose: Returns the orientation of the current sub-shape.
66 raises
67 NoSuchObject from Standard
68 ---C++: inline
69 is static;
70
71fields
72
73 myIterator : Iterator from TopoDS;
74
75end Iterator from BRepSweep;