Integration of OCCT 6.5.0 from SVN
[occt.git] / src / TFunction / TFunction_GraphNode.cdl
CommitLineData
7fd59977 1-- File: TFunction_GraphNode.cdl
2-- Created: Mon Jun 21 14:25:12 2008
3-- Author: Vladislav ROMASHKO
4-- <vladislav.romashko@opencascade.com>
5---Copyright: Open CASCADE S.A.
6
7class GraphNode from TFunction inherits Attribute from TDF
8
9 ---Purpose: Provides links between functions.
10
11uses
12
13 GUID from Standard,
14 OStream from Standard,
15 Attribute from TDF,
16 RelocationTable from TDF,
17 DataSet from TDF,
18 Label from TDF,
19 MapOfInteger from TColStd,
20 ExecutionStatus from TFunction
21
22is
23
24 ---Purpose: Static methods
25 -- ==============
26
27 Set (myclass; L : Label from TDF)
28 ---Purpose: Finds or Creates a graph node attribute at the label <L>.
29 -- Returns the attribute.
30 returns GraphNode from TFunction;
31
32 GetID (myclass)
33 ---Purpose: Returns the GUID for GraphNode attribute.
34 ---C++: return const &
35 returns GUID from Standard;
36
37
38 ---Purpose: Instant methods
39 -- ===============
40
41 Create
42 ---Purpose: Constructor (empty).
43 returns mutable GraphNode from TFunction;
44
45
46 AddPrevious (me : mutable;
47 funcID : Integer from Standard)
48 ---Purpose: Defines a reference to the function as a previous one.
49 returns Boolean from Standard;
50
51 AddPrevious (me : mutable;
52 func : Label from TDF)
53 ---Purpose: Defines a reference to the function as a previous one.
54 returns Boolean from Standard;
55
56 RemovePrevious (me : mutable;
57 funcID : Integer from Standard)
58 ---Purpose: Removes a reference to the function as a previous one.
59 returns Boolean from Standard;
60
61 RemovePrevious (me : mutable;
62 func : Label from TDF)
63 ---Purpose: Removes a reference to the function as a previous one.
64 returns Boolean from Standard;
65
66 GetPrevious (me)
67 ---C++: return const &
68 ---Purpose: Returns a map of previous functions.
69 returns MapOfInteger from TColStd;
70
71 RemoveAllPrevious (me : mutable);
72 ---Purpose: Clears a map of previous functions.
73
74
75 AddNext (me : mutable;
76 funcID : Integer from Standard)
77 ---Purpose: Defines a reference to the function as a next one.
78 returns Boolean from Standard;
79
80 AddNext (me : mutable;
81 func : Label from TDF)
82 ---Purpose: Defines a reference to the function as a next one.
83 returns Boolean from Standard;
84
85 RemoveNext (me : mutable;
86 funcID : Integer from Standard)
87 ---Purpose: Removes a reference to the function as a next one.
88 returns Boolean from Standard;
89
90 RemoveNext (me : mutable;
91 func : Label from TDF)
92 ---Purpose: Removes a reference to the function as a next one.
93 returns Boolean from Standard;
94
95 GetNext (me)
96 ---C++: return const &
97 ---Purpose: Returns a map of next functions.
98 returns MapOfInteger from TColStd;
99
100 RemoveAllNext (me : mutable);
101 ---Purpose: Clears a map of next functions.
102
103
104 GetStatus (me)
105 ---Purpose: Returns the execution status of the function.
106 returns ExecutionStatus from TFunction;
107
108 SetStatus (me : mutable;
109 status : ExecutionStatus from TFunction);
110 ---Purpose: Defines an execution status for a function.
111
112
113 ---Purpose: Implementation of Attribute methods
114 -- ===================================
115
116 ID (me)
117 ---C++: return const &
118 returns GUID from Standard;
119
120 Restore (me: mutable; with : Attribute from TDF)
121 is virtual;
122
123 Paste (me; into : mutable Attribute from TDF;
124 RT : mutable RelocationTable from TDF)
125 is virtual;
126
127 NewEmpty (me)
128 returns mutable Attribute from TDF
129 is redefined;
130
131 References (me;
132 aDataSet : DataSet from TDF)
133 is redefined;
134
135 Dump (me; anOS : in out OStream from Standard)
136 ---C++: return &
137 returns OStream from Standard
138 is redefined;
139
140
141fields
142
143 myPrevious : MapOfInteger from TColStd;
144 myNext : MapOfInteger from TColStd;
145 myStatus : ExecutionStatus from TFunction;
146
147end GraphNode;