blob: ef2dcd6c1d9bbc764abf2c81d11353ecd5118a10 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
-- File: TFunction_Logbook.cdl
-- Created: Mon Jul 19 15:12:56 1999
-- Author: Denis PASCAL
-- <dp@dingox.paris1.matra-dtv.fr>
---Copyright: Matra Datavision 1999
class Logbook from TFunction
---Purpose: This class contains information which is written and
-- read during the solving process. Information is divided
-- in three groups.
--
-- * Touched Labels (modified by the end user),
-- * Impacted Labels (modified during execution of the function),
-- * Valid Labels (within the valid label scope).
uses Label from TDF,
LabelMap from TDF,
Logbook from TFunction
is
---Purpose: next methods are solving declaration
-- ===================================
Create returns Logbook from TFunction;
Clear (me : in out);
---Purpose: Clears this logbook to its default, empty state.
IsEmpty (me)
returns Boolean from Standard;
SetTouched (me : in out; L : Label from TDF);
---C++ : inline
---Purpose: Sets the label L as a touched label in this logbook.
-- In other words, L is understood to have been modified by the end user.
SetImpacted (me : in out; L : Label from TDF;
WithChildren : Boolean from Standard = Standard_False);
---Purpose: Sets the label L as an impacted label in this logbook.
-- This method is called by execution of the function driver.
SetValid (me : in out; L : Label from TDF;
WithChildren : Boolean from Standard = Standard_False);
---Purpose: Sets the label L as a valid label in this logbook.
ChangeValid (me : in out)
---C++: return &
---C++ : inline
returns LabelMap from TDF;
IsModified (me; L : Label from TDF;
WithChildren : Boolean from Standard = Standard_False)
---Purpose: Returns True if the label L is touched or impacted. This method
-- is called by <TFunction_FunctionDriver::MustExecute>.
-- If <WithChildren> is set to true, the method checks
-- all the sublabels of <L> too.
returns Boolean from Standard;
---Purpose: next method to consult solving result
-- =====================================
GetTouched (me)
---C++: return const &
---C++: inline
---Purpose:
-- Returns the map of touched labels in this logbook.
-- A touched label is the one modified by the end user.
returns LabelMap from TDF;
GetImpacted (me)
---C++: return const &
---C++: inline
---Purpose:
-- Returns the map of impacted labels contained in this logbook.
returns LabelMap from TDF;
GetValid (me)
---C++: return const &
---C++: inline
---Purpose: Returns the map of valid labels in this logbook.
returns LabelMap from TDF;
Done (me : in out; status : Boolean from Standard);
---Purpose: Sets if the execution failed
---C++: inline
IsDone (me)
returns Boolean from Standard;
---C++: inline
Dump(me; stream : in out OStream from Standard)
---C++: return &
returns OStream from Standard;
fields
myTouched : LabelMap from TDF;
myImpacted : LabelMap from TDF;
myValid : LabelMap from TDF;
isDone : Boolean from Standard;
end Logbook;
|