0023024: Update headers of OCCT 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
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
7fd59977 21
22
23
24class Iterator from BRepSweep
25
26 ---Purpose: This class provides iteration services required by
27 -- the Generating Line (TopoDS Shape) of a BRepSweep.
28 -- This tool is used to iterate on the direct
29 -- sub-shapes of a Shape.
30 --
31
32uses
33
34 Iterator from TopoDS,
35 Shape from TopoDS,
36 Orientation from TopAbs
37
38raises
39
40 NoMoreObject from Standard,
41 NoSuchObject from Standard
42
43is
44
45 Create;
46
47 Init(me : in out; aShape: Shape from TopoDS)
48 ---Purpose: Resest the Iterator on sub-shapes of <aShape>.
49 is static;
50
51 More(me) returns Boolean
52 ---Purpose: Returns True if there is a current sub-shape.
53 --
54 ---C++: inline
55 is static;
56
57 Next(me : in out)
58 ---Purpose: Moves to the next sub-shape.
59 raises
60 NoMoreObject from Standard
61 is static;
62
63 Value(me) returns Shape from TopoDS
64 ---Purpose: Returns the current sub-shape.
65 raises
66 NoSuchObject from Standard
67 ---C++: return const &
68 ---C++: inline
69 is static;
70
71 Orientation(me) returns Orientation from TopAbs
72 ---Purpose: Returns the orientation of the current sub-shape.
73 raises
74 NoSuchObject from Standard
75 ---C++: inline
76 is static;
77
78fields
79
80 myIterator : Iterator from TopoDS;
81
82end Iterator from BRepSweep;