0024927: Getting rid of "Persistent" functionality -- Storable
[occt.git] / src / GccEnt / GccEnt_QualifiedCirc.cdl
1 -- Created on: 1991-04-15
2 -- Created by: Philippe DAUTRY
3 -- Copyright (c) 1991-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 QualifiedCirc
18
19 from GccEnt
20
21         ---Purpose: Creates a qualified 2d Circle.
22         -- A qualified 2D circle is a circle (gp_Circ2d circle) with a
23         -- qualifier which specifies whether the solution of a
24         -- construction algorithm using the qualified circle (as an argument):
25         -- -   encloses the circle, or
26         -- -   is enclosed by the circle, or
27         -- -   is built so that both the circle and it are external to   one another, or
28         -- -   is undefined (all solutions apply).
29
30 uses Position from GccEnt,
31      Circ2d   from gp
32
33 is
34
35 Create(Qualified : Circ2d   from gp     ;
36        Qualifier : Position from GccEnt ) returns QualifiedCirc from GccEnt;
37         ---Purpose: Constructs a qualified circle by assigning the qualifier
38         -- Qualifier to the circle Qualified. Qualifier may be:
39         -- -   GccEnt_enclosing if the solution computed by a
40         --   construction algorithm using the qualified circle
41         --   encloses the circle, or
42         -- -   GccEnt_enclosed if the solution is enclosed by the circle, or
43         -- -   GccEnt_outside if both the solution and the circle
44         --   are external to one another, or
45         -- -   GccEnt_unqualified if all solutions apply.
46
47 Qualified(me) returns Circ2d from gp
48 is static;
49         ---Purpose: Returns a 2D circle to which the qualifier is assigned.
50     
51 Qualifier(me) returns Position from GccEnt
52 is static;
53         ---Purpose: Returns
54         -- -   the qualifier of this qualified circle, if it is enclosing,
55         -- enclosed or outside, or
56         -- -   GccEnt_noqualifier if it is unqualified.
57         
58 IsUnqualified(me) returns Boolean from Standard
59 is static;
60         ---Purpose: Returns true if the Circ2d is Unqualified and false in 
61         --          the other cases.
62
63 IsEnclosing(me) returns Boolean from Standard
64 is static;
65         ---Purpose: Returns true if the solution computed by a construction
66         -- algorithm using this qualified circle encloses the circle.
67
68 IsEnclosed(me) returns Boolean from Standard
69 is static;
70         ---Purpose: Returns true if the solution computed by a construction
71         -- algorithm using this qualified circle is enclosed by the circle.
72
73     IsOutside(me) returns Boolean from Standard
74 is static;
75         ---Purpose: Returns true if both the solution computed by a
76         -- construction algorithm using this qualified circle and the
77         -- circle are external to one another.
78
79 fields
80
81 TheQualified : Circ2d   from gp;
82 TheQualifier : Position from GccEnt;
83
84 --friends
85
86 --Unqualified (Obj : Circ2d) from GccEnt,
87 --Enclosing   (Obj : Circ2d) from GccEnt,
88 --Enclosed    (Obj : Circ2d) from GccEnt,
89 --Outside     (Obj : Circ2d) from GccEnt
90
91 end QualifiedCirc;
92