0024784: Move documentation in CDL files to proper location
[occt.git] / src / BRepAdaptor / BRepAdaptor.cdl
1 -- Created on: 1993-02-19
2 -- Created by: Remi LEQUETTE
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 package BRepAdaptor 
18
19         ---Purpose: The BRepAdaptor package provides classes to access 
20         --          the geometry of the BRep models.
21         --          
22         --          OverView of classes
23         --          
24         --          * Surface :  Provides the methods  of Surface from
25         --          Adpator on a Face.
26         --          
27         --          *  Curve  : Provides  the  methods of  Curve  from
28         --          Adaptor3d on an Edge.
29         --          
30         --          * Curve2d : Provides  the methods of  Curve2d from
31         --          Adaptor2d on an Edge on a Face.
32         --          
33
34 uses
35     gp, 
36     TCollection,
37     TColgp,
38     TColStd,
39     GeomAbs,
40     Adaptor3d,
41     Adaptor2d,
42     Geom,
43     Geom2d,
44     GeomAdaptor,
45     Geom2dAdaptor,
46     TopoDS,
47     BRep
48
49 is
50
51     class Surface;
52         
53     class Curve;
54
55     class Curve2d;
56
57     class  CompCurve; 
58         
59     class HSurface instantiates GenHSurface from Adaptor3d
60         (Surface from BRepAdaptor);
61
62     class HCurve instantiates GenHCurve from Adaptor3d
63         (Curve from BRepAdaptor);
64
65     class HCurve2d instantiates GenHCurve2d from Adaptor2d
66         (Curve2d from BRepAdaptor); 
67          
68     class HCompCurve instantiates GenHCurve from Adaptor3d
69         (CompCurve from BRepAdaptor); 
70          
71     class Array1OfCurve 
72         instantiates Array1 from TCollection (Curve from BRepAdaptor); 
73          
74     class HArray1OfCurve
75         instantiates HArray1 from TCollection (Curve from BRepAdaptor,
76                                 Array1OfCurve from BRepAdaptor);
77
78 end BRepAdaptor;