0022627: Change OCCT memory management defaults
[occt.git] / src / DDF / DDF.cdl
CommitLineData
7fd59977 1-- File: DDF.cdl
2-- -------
3-- Author: DAUTRY Philippe
4---Copyright: MATRA DATAVISION 1997
5
6---Version: 0.0
7---History: Version Date Purpose
8-- 0.0 Feb 10 1997 Creation
9
10
11
12package DDF
13
14 ---Purpose: Provides facilities to manipulate data framework
15 -- in a Draw-Commands environment.
16
17uses
18
19 Standard,
20 Draw,
21 TCollection,
22 TDF
23
24is
25
26 -- ----------------------------------------------------------------------
27 -- Classes
28 -- ----------------------------------------------------------------------
29
30 class Data;
31 ---Purpose : Encapsulates a data framework from TDF.
32
33 class Browser;
34 ---Purpose : Browses a data framework from TDF.
35
36 class Transaction;
37 ---Purpose: Encapsulates a Transaction from TDF.
38
39 class TransactionStack
40 instantiates Stack from TCollection (Transaction from DDF);
41
42 -- ----------------------------------------------------------------------
43 -- Package methods
44 -- ----------------------------------------------------------------------
45
46
47 GetDF (Name : in out CString from Standard;
48 DF : in out Data from TDF;
49 Complain : in Boolean from Standard = Standard_True)
50 returns Boolean;
51 ---Purpose: Search in draw directory the framewok identified
52 -- by its name <Name>. returns True if found. In that
53 -- case <DF> is setted.
54
55
56 FindLabel (DF : in Data from TDF;
57 Entry : in CString from Standard;
58 Label : in out Label from TDF;
59 Complain : in Boolean from Standard = Standard_True)
60 returns Boolean;
61 ---Purpose: Search in <DF> the label identified by its entry
62 -- <Entry>. returns <True> if found. In that case
63 -- <Label> is setted.
64
65 AddLabel (DF : in Data from TDF;
66 Entry : in CString from Standard;
67 Label : in out Label from TDF)
68 returns Boolean;
69 ---Purpose : Search in <DF> the label identified by its entry
70 -- <Entry>. if label doesn't exist, create and add
71 -- the Label in <DF>. In that case return True.
72
73
74 Find (DF : in Data from TDF;
75 Entry : in CString from Standard;
76 ID : in GUID from Standard;
77 A : in out Attribute from TDF;
78 Complain : Boolean from Standard = Standard_True)
79 returns Boolean;
80 ---Purpose: Search in <DF> the attribute identified by its
81 -- <ID> and its <entry>. returns <True> if found. In
82 -- that case A is setted.
83
84
85 ReturnLabel(theCommands : in out Interpretor from Draw; L : Label from TDF)
86 returns Interpretor from Draw;
87 ---C++: return &
88
89 -- ----------------------------------------------------------------------
90 -- Commands
91 -- ----------------------------------------------------------------------
92
93 AllCommands (theCommands : in out Interpretor from Draw);
94
95
96 BasicCommands (theCommands : in out Interpretor from Draw);
97 ---Purpose : Basic commands.
98
99 DataCommands (theCommands : in out Interpretor from Draw);
100 ---Purpose : Data framework commands
101 -- create, clear & copy.
102
103 TransactionCommands (theCommands : in out Interpretor from Draw);
104 ---Purpose : open commit abort a transaction
105 -- undo facilities.
106
107 BrowserCommands (theCommands : in out Interpretor from Draw);
108 ---Purpose : Browser commands .
109
110end DDF;
111
112
113