0023024: Update headers of OCCT files
[occt.git] / src / BOP / BOP_LoopSet.cdl
1 -- Created on: 1993-03-23
2 -- Created by: Jean Yves LEBEY
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
21
22 class LoopSet from BOP 
23
24     ---Purpose:  
25     --  The auxiliary class to store  and iterate on Loop(s) 
26 uses
27
28     Loop                     from BOP,
29     ListOfLoop               from BOP,
30     ListIteratorOfListOfLoop from BOP
31
32 is
33     
34     Create  
35         returns LoopSet;
36         ---Purpose:  
37         --- Empty constructor;  
38         ---
39     Delete(me:out)  
40         is virtual;
41         ---C++: alias "Standard_EXPORT virtual ~BOP_LoopSet(){Delete() ; }"
42         ---Purpose:  
43         --- Destructor;  
44         ---
45     ChangeListOfLoop(me : in out)  
46         returns ListOfLoop  
47         is static;
48         ---C++: return &
49         ---Purpose:  
50         --- Modifier;  
51
52     --- 
53     --- Exploration of the loops
54     --- 
55     InitLoop(me : in out)  
56         is virtual;
57      
58     MoreLoop(me)  
59         returns Boolean  
60         is virtual;
61      
62     NextLoop(me : in out)  
63         is virtual;
64      
65     Loop(me)  
66         returns Loop from BOP  
67         is virtual;
68         ---C++: return const &
69     
70 fields
71
72     myListOfLoop   : ListOfLoop               from BOP;
73     myLoopIterator : ListIteratorOfListOfLoop from BOP;
74     myLoopIndex    : Integer from Standard;
75     myNbLoop       : Integer from Standard;
76     
77 end LoopSet;