0023024: Update headers of OCCT files
[occt.git] / src / BRepAdaptor / BRepAdaptor_Curve2d.cdl
1 -- Created on: 1993-07-13
2 -- Created by: Remi LEQUETTE
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
23
24 class Curve2d from BRepAdaptor inherits Curve from Geom2dAdaptor
25
26         ---Purpose: The Curve2d from BRepAdaptor allows to use an Edge
27         --          on   a Face like   a  2d   curve. (curve  in   the
28         --          parametric space).
29         --          
30         --          It  has  the methods    of the class Curve2d  from
31         --          Adpator. 
32         --          
33         --          It  is created or  initialized with a  Face and an
34         --          Edge.  The methods are  inherited from  Curve from
35         --          Geom2dAdaptor. 
36
37 uses
38     Face from TopoDS,
39     Edge from TopoDS
40
41 raises
42     NullObject from Standard
43
44 is
45
46     Create returns Curve2d from BRepAdaptor;
47         ---Purpose: Creates an uninitialized curve2d.
48
49     Create(E : Edge from TopoDS; F : Face from TopoDS)
50     returns Curve2d from BRepAdaptor
51         ---Purpose: Creates with the pcurve of <E> on <F>.
52     raises
53         NullObject from Standard; -- if <E> has no pcurve on <F>
54         
55     Initialize(me : in out; E : Edge from TopoDS; F : Face from TopoDS)
56         ---Purpose: Initialize with the pcurve of <E> on <F>.
57     raises
58         NullObject from Standard -- if <E> has no pcurve on <F>
59     is static;
60     
61     Edge(me) returns Edge from TopoDS
62         ---Purpose: Returns the Edge.
63         --          
64         ---C++: return const &
65     is static;
66
67     Face(me) returns Face from TopoDS
68         ---Purpose: Returns the Face.
69         --          
70         ---C++: return const &
71     is static;
72
73 fields
74
75     myEdge : Edge from TopoDS;
76     myFace : Face from TopoDS;
77         
78 end Curve2d;