0023024: Update headers of OCCT files
[occt.git] / src / BOP / BOP_Loop.cdl
CommitLineData
b311480e 1-- Created on: 1995-12-19
2-- Created by: Jean Yves LEBEY
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
7fd59977 21
22class Loop from BOP inherits TShared from MMgt
23
24 ---Purpose:
25 -- A Loop is an existing shape (Shell,Wire) or a set
26 -- of shapes (Faces,Edges) which are connex.
27 -- a set of connex shape is represented by a BlockIterator
28
29uses
30
31 Shape from TopoDS,
32 BlockIterator from BOP,
33 ShapeEnum from TopAbs
34
35is
36
37 Create(S : Shape from TopoDS)
38 returns mutable Loop;
39 ---Purpose:
40 --- Creates the object using the shape S;
41 ---
42 Create(BI : BlockIterator from BOP)
43 returns mutable Loop;
44 ---Purpose:
45 --- Creates the object using the BlockIterator BI;
46 ---
47 IsShape(me)
48 returns Boolean from Standard
49 is virtual;
50 ---Purpose:
51 --- Returns TRUE if the object was created using shape
52 ---
53 Shape(me)
54 returns Shape from TopoDS
55 is virtual;
56 ---C++: return const &
57 ---Purpose:
58 --- Returns Shape from which the object was created
59 --- Valid only when IsShape() is TRUE
60 ---
61 BlockIterator(me)
62 returns BlockIterator
63 is static;
64 ---C++: return const &
65 --- Returns BlockIterator from which the object was created
66 --- Valid only when IsShape() is FALSE
67 ---
68
69fields
70 myIsShape : Boolean from Standard
71 is protected;
72 myShape : Shape from TopoDS
73 is protected;
74 myBlockIterator : BlockIterator from BOP
75 is protected;
76
77end Loop from BOP;