0023024: Update headers of OCCT files
[occt.git] / src / Adaptor3d / Adaptor3d_GenHSurface.cdl
1 -- Created on: 1994-02-14
2 -- Created by: model
3 -- Copyright (c) 1994-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 generic class GenHSurface from Adaptor3d
24     (TheSurface as Surface from Adaptor3d)
25  
26 inherits HSurface from Adaptor3d 
27     
28         ---Purpose: Generic class used to create a surface manipulated
29         --          with Handle from a surface described by the class Surface. 
30         
31 uses
32
33      Surface      from Adaptor3d
34
35
36 raises
37
38     OutOfRange          from Standard,
39     NoSuchObject        from Standard,
40     DomainError         from Standard
41
42
43 is
44
45     Create
46     
47         ---Purpose: Creates an empty GenHSurface.
48         returns mutable GenHSurface from Adaptor3d; 
49     
50
51     Create(S: TheSurface)
52     
53         ---Purpose: Creates a GenHSurface from a Surface.
54         returns mutable GenHSurface from Adaptor3d; 
55
56
57     Set(me: mutable; S: TheSurface)
58     
59         ---Purpose: Sets the field of the GenHSurface.
60         is static;
61
62     --
63     --  Access to the surface
64     --  
65     
66     Surface(me) returns Surface from Adaptor3d;
67         ---Purpose: Returns a reference to the Surface inside the HSurface.
68         --          This is redefined from HSurface, cannot be inline.
69         --          
70         ---C++: return const &
71
72     ChangeSurface(me : mutable)
73     
74         ---Purpose: Returns the surface used to create the GenHSurface.
75         --          
76         ---C++: return &
77         ---C++: inline
78
79         returns TheSurface;
80
81
82 fields
83
84     mySurf: TheSurface is protected;
85
86 end GenHSurface;