0023024: Update headers of OCCT files
[occt.git] / src / BinMNaming / BinMNaming_NamedShapeDriver.cdl
1 -- Created on: 2004-04-08
2 -- Created by: Sergey ZARITCHNY <szy@opencascade.com>
3 -- Copyright (c) 2004-2012 OPEN CASCADE SAS
4 --
5 -- The content of this file is subject to the Open CASCADE Technology Public
6 -- License Version 6.5 (the "License"). You may not use the content of this file
7 -- except in compliance with the License. Please obtain a copy of the License
8 -- at http://www.opencascade.org and read it completely before using this file.
9 --
10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
12 --
13 -- The Original Code and all software distributed under the License is
14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
15 -- Initial Developer hereby disclaims all such warranties, including without
16 -- limitation, any warranties of merchantability, fitness for a particular
17 -- purpose or non-infringement. Please see the License for the specific terms
18 -- and conditions governing the rights and limitations under the License.
19
20
21
22 class NamedShapeDriver from BinMNaming inherits ADriver from BinMDF
23
24         ---Purpose: NamedShape  Attribute Driver.
25
26 uses
27     SRelocationTable from BinObjMgt,
28     RRelocationTable from BinObjMgt,
29     Persistent       from BinObjMgt,
30     MessageDriver    from CDM,
31     Attribute        from TDF, 
32     ShapeSet         from BinTools,
33     LocationSet      from BinTools
34
35 is
36     Create (theMessageDriver:MessageDriver from CDM)
37         returns mutable NamedShapeDriver from BinMNaming;
38
39     NewEmpty (me)  returns mutable Attribute from TDF;
40
41     Paste(me; Source     : Persistent from BinObjMgt;
42               Target     : mutable Attribute from TDF;
43               RelocTable : out RRelocationTable from BinObjMgt)
44         returns Boolean from Standard;
45
46     Paste(me; Source     : Attribute from TDF;
47               Target     : in out Persistent from BinObjMgt;
48               RelocTable : out SRelocationTable from BinObjMgt);
49     
50     ReadShapeSection (me: mutable; theIS: in out IStream from Standard);
51       ---Purpose: Input the shapes from Bin Document file
52
53     WriteShapeSection (me: mutable; theOS: in out OStream from Standard);
54       ---Purpose: Output the shapes into Bin Document file
55
56     Clear (me:mutable);
57       ---Purpose: Clear myShapeSet 
58        
59     SetFormatNb(me: mutable; theFormat : Integer from Standard);  
60     ---C++: inline 
61     ---Purpose: set the format of topology  
62     --          First : does not write CurveOnSurface UV Points into the file
63     --                  on reading calls Check() method.
64     --          Second: stores CurveOnSurface UV Points.
65
66     GetFormatNb(me) returns Integer from Standard; 
67     ---Purpose: get the format of topology  
68     ---C++: inline 
69     
70     GetShapesLocations(me: mutable) returns LocationSet from BinTools; 
71     ---Purpose: get the format of topology  
72     ---C++: return &
73     ---C++: inline 
74     
75 fields
76      
77     myShapeSet          : ShapeSet from BinTools; 
78     myFormatNb          : Integer  from Standard;
79 end NamedShapeDriver;