0023024: Update headers of OCCT files
[occt.git] / src / XSControl / XSControl_Writer.cdl
1 -- Created on: 1997-05-14
2 -- Created by: Christian CAILLET
3 -- Copyright (c) 1997-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 class Writer  from XSControl
24
25     ---Purpose : This class gives a simple way to create then write a
26     --           Model compliant to a given norm, from a Shape
27     --           The model can then be edited by tools by other appropriate tools
28
29 uses CString,
30      InterfaceModel from Interface, WorkSession from XSControl,
31      ReturnStatus from IFSelect,
32      Shape from TopoDS
33
34 is
35
36     Create returns Writer;
37     ---Purpose : Creates a Writer from scratch
38
39     Create (norm : CString) returns Writer;
40     ---Purpose : Creates a Writer from scratch, with a norm name which
41     --           identifie a Controller
42
43     Create (WS : mutable WorkSession from XSControl;
44                  scratch : Boolean = Standard_True) returns Writer;
45     ---Purpose : Creates a Writer from an already existing Session
46     --           If <scratch> is True (D), clears already recorded data
47
48     SetNorm (me : in out; norm : CString) returns Boolean;
49     ---Purpose : Sets a specific norm to <me>
50     --           Returns True if done, False if <norm> is not available
51
52     SetWS (me : in out; WS : mutable WorkSession from XSControl;
53                  scratch : Boolean = Standard_True);
54     ---Purpose : Sets a specific session to <me>
55
56     WS (me) returns WorkSession from XSControl;
57     ---Purpose : Returns the session used in <me>
58
59     Model (me : in out; newone : Boolean = Standard_False) returns InterfaceModel;
60     ---Purpose : Returns the produced model. Produces a new one if not yet done
61     --           or if <newone> is True
62     --           This method allows for instance to edit product or header
63     --           data before writing
64
65     TransferShape (me : in out; sh : Shape from TopoDS; mode : Integer = 0)
66         returns ReturnStatus;
67     ---Purpose : Transfers a Shape according to the mode
68
69     WriteFile (me : in out; filename : CString) returns ReturnStatus;
70     ---Purpose : Writes the produced model
71
72     PrintStatsTransfer (me; what : Integer; mode : Integer = 0);
73     ---Purpose : Prints Statistics about Transfer
74
75 fields
76
77     thesession : WorkSession from XSControl;
78
79 end Writer;