0024927: Getting rid of "Persistent" functionality -- Code
[occt.git] / src / PGeom2d / PGeom2d_Hyperbola.cdl
1 -- Created on: 1993-04-06
2 -- Created by: Philippe DAUTRY
3 -- Copyright (c) 1993-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 Hyperbola from PGeom2d inherits Conic from PGeom2d
18
19         ---Purpose :Defines the main branch of an hyperbola.
20         --         
21         ---See Also : Hyperbola from Geom2d.
22
23 uses Ax22d from gp
24
25 is
26
27
28   Create returns Hyperbola from PGeom2d;
29         ---Purpose :Creates an Hyperbola with default values.
30         ---Level: Internal 
31
32
33   Create (aPosition : Ax22d from gp;
34           aMajorRadius, aMinorRadius : Real from Standard)
35      returns Hyperbola from PGeom2d;
36         ---Purpose :  Creates an   Hyperbola    with      <aPosition>,
37         --         <aMajorRadius> and  <aMinorRadius> as field values.
38         --         The major  radius of the hyperbola is  on the XAxis
39         --         and   the minor  radius is  on    the YAxis of  the
40         --         hyperbola.
41         ---Level: Internal 
42
43
44   MajorRadius (me : mutable; aMajorRadius : Real from Standard);
45         ---Purpose: Set the value of the field majorRadius with <aMajorRadius>.
46         ---Level: Internal 
47
48
49   MajorRadius (me)  returns Real from Standard;
50         ---Purpose: Returns the value of the field majorRadius.
51         ---Level: Internal 
52
53
54   MinorRadius (me : mutable; aMinorRadius : Real from Standard);
55         ---Purpose: Set the value of the field minorRadius with <aMinorRadius>.
56         ---Level: Internal 
57
58
59   MinorRadius (me)  returns Real from Standard;
60         ---Purpose: Returns the value of the field minorRadius.
61         ---Level: Internal 
62
63
64 fields
65
66      majorRadius : Real from Standard;
67      minorRadius : Real from Standard;
68
69 end;
70