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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
|
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lazutils">
<!--
====================================================================
LazLoggerProfiling
====================================================================
-->
<module name="LazLoggerProfiling">
<short>Contains classes and routines used for profiling in the Lazarus debugger.</short>
<descr>
<p>
This file is part of the <file>LazUtils</file> package.
</p>
</descr>
<!-- class Visibility: default -->
<element name="TLazLoggerBlockTimer">
<short>
Provides profiler instrumentation for execution times in a logger class.
</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TLazLoggerBlockTimer.FMaxDepth"/>
<element name="TLazLoggerBlockTimer.FTimes"/>
<element name="TLazLoggerBlockTimer.FNested"/>
<element name="TLazLoggerBlockTimer.GetNested"/>
<element name="TLazLoggerBlockTimer.GetNested.Result"/>
<element name="TLazLoggerBlockTimer.GetNested.ALevel"/>
<element name="TLazLoggerBlockTimer.GetTimeDiff"/>
<element name="TLazLoggerBlockTimer.GetTimeDiff.Result"/>
<element name="TLazLoggerBlockTimer.GetTimeDiff.ALevel"/>
<element name="TLazLoggerBlockTimer.SetMaxDepth"/>
<element name="TLazLoggerBlockTimer.SetMaxDepth.AValue"/>
<!-- constructor Visibility: public -->
<element name="TLazLoggerBlockTimer.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
Create sets the default value for the MaxDepth property (100), and initializes the first time value in the execution time profiler. The initial nesting level is also set (0).
</p>
</descr>
<seealso/>
</element>
<!-- procedure Visibility: public -->
<element name="TLazLoggerBlockTimer.EnterBlock">
<short>
Captures the execution start time and nesting level when a new block is entered.
</short>
<descr>
</descr>
<seealso/>
</element>
<element name="TLazLoggerBlockTimer.EnterBlock.Sender">
<short>Logger class instance for the block handler.</short>
</element>
<element name="TLazLoggerBlockTimer.EnterBlock.Level">
<short>Current nesting level for the block handler.</short>
</element>
<!-- procedure Visibility: public -->
<element name="TLazLoggerBlockTimer.ExitBlock">
<short>
Updates the cumulative execution time when a block is exited.
</short>
<descr/>
<seealso/>
</element>
<element name="TLazLoggerBlockTimer.ExitBlock.Sender">
<short>Logger class instance for the block handler.</short>
</element>
<element name="TLazLoggerBlockTimer.ExitBlock.Level">
<short>Nesting level before the block handler is exited.</short>
</element>
<!-- property Visibility: public -->
<element name="TLazLoggerBlockTimer.MaxDepth">
<short>
Maximum depth for execution time data in the nested levels for the block handler.
</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TLazLoggerBlockTimer.TimeDiff">
<short>
Calculates the cumulative execution time for the block at the specified nesting level.
</short>
<descr>
<p>
TimeDiff is a read-only QWord property which provides indexed access to the cumulative execution time for the block at the specified nesting level. The value represents a number of "ticks" or milliseconds as returned from the GetTickCount64 routine in the RTL.
</p>
<p>
The property value is calculated as the difference between the current "tick" value and the execution start time from the parent block. A timer overflow condition is handled in the calculation. The property value is 0 (zero) when ALevel is not in the range 0..MaxDepth.
</p>
</descr>
<seealso>
</seealso>
</element>
<element name="TLazLoggerBlockTimer.TimeDiff.ALevel">
<short>Nesting level for the block execution time calculated in the method.</short>
</element>
<element name="TLazLoggerBlockTimer.Nested">
<short>Execution time data for the block at the specified nesting level.</short>
<descr/>
<seealso/>
</element>
<element name="TLazLoggerBlockTimer.Nested.ALevel">
<short>Nesting level for the calculated execution time.</short>
</element>
<!-- class Visibility: default -->
<element name="TLazLoggerBlockMemWatch">
<short>
Provides profiler instrumentation for memory allocation (heap) in a logger class.
</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TLazLoggerBlockMemWatch.FMaxDepth"/>
<element name="TLazLoggerBlockMemWatch.FMem"/>
<element name="TLazLoggerBlockMemWatch.FNested"/>
<element name="TLazLoggerBlockMemWatch.GetMemDiff"/>
<element name="TLazLoggerBlockMemWatch.GetMemDiff.Result"/>
<element name="TLazLoggerBlockMemWatch.GetMemDiff.ALevel"/>
<element name="TLazLoggerBlockMemWatch.GetNested"/>
<element name="TLazLoggerBlockMemWatch.GetNested.Result"/>
<element name="TLazLoggerBlockMemWatch.GetNested.ALevel"/>
<element name="TLazLoggerBlockMemWatch.SetMaxDepth"/>
<element name="TLazLoggerBlockMemWatch.SetMaxDepth.AValue"/>
<!-- constructor Visibility: public -->
<element name="TLazLoggerBlockMemWatch.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>
Create sets the default value for the MaxDepth property (100), and initializes the first values for the memory allocation profiler. The initial nesting level is also set (0).
</p></descr>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TLazLoggerBlockMemWatch.EnterBlock">
<short>Captures memory allocation and nesting level when a block is entered.</short>
<descr/>
<seealso/>
</element>
<element name="TLazLoggerBlockMemWatch.EnterBlock.Sender">
<short>Logger class instrumented in the profiler tool.</short>
</element>
<element name="TLazLoggerBlockMemWatch.EnterBlock.Level">
<short>Current nesting level for the block.</short>
</element>
<!-- procedure Visibility: public -->
<element name="TLazLoggerBlockMemWatch.ExitBlock">
<short>
Updates the cumulative memory allocation for the parent block when a block is exited.
</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="TLazLoggerBlockMemWatch.ExitBlock.Sender">
<short>Logger class for the block handler.</short>
</element>
<element name="TLazLoggerBlockMemWatch.ExitBlock.Level">
<short></short>
</element>
<!-- property Visibility: public -->
<element name="TLazLoggerBlockMemWatch.MaxDepth">
<short>
Maximum depth the nested levels in the block handler.
</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TLazLoggerBlockMemWatch.MemDiff">
<short>Indicates heap memory allocation for the block at the specified nesting level.</short>
<descr>
<p>
MemDiff is a read-only Int64 property which provides indexed access to the cumulative memory usage for a block at a specified nesting level. The value is calculated as the difference between the current memory allocation in the block and the initial memory allocation in the parent block. The property value reflects heap memory allocation.
</p>
<p>
The property value is 0 (zero) if ALevel is not in the range 0..MaxDepth.
</p>
</descr>
<seealso>
</seealso>
</element>
<element name="TLazLoggerBlockMemWatch.MemDiff.ALevel">
<short>Nesting level for the block reflected in the property value.</short>
</element>
<!-- property Visibility: public -->
<element name="TLazLoggerBlockMemWatch.Nested">
<short>Memory allocation data for the block at the specified nesting level.</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<element name="TLazLoggerBlockMemWatch.Nested.ALevel">
<short>Nesting level for the block reflected in the property value.</short>
</element>
<!-- function Visibility: default -->
<element name="DbgsMemUsed">
<short>
Generates a formatted message with memory usage for the parent, current, or child block(s).
</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="DbgsMemUsed.Result">
<short></short>
</element>
<element name="DbgsMemUsed.AName">
<short></short>
</element>
<element name="DbgsMemUsed.AFormat">
<short></short>
</element>
<!-- function Visibility: default -->
<element name="DbgsTimeUsed">
<short>
Generates a formatted message with execution times for the parent, current, or child blocks.
</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="DbgsTimeUsed.Result">
<short></short>
</element>
<element name="DbgsTimeUsed.AName">
<short></short>
</element>
<element name="DbgsTimeUsed.AFormat">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="DbgStartTimer">
<short>
Gets or creates timing data for the specified name, and updates its last execution time.
</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="DbgStartTimer.AName">
<short>Name for the timing data retrieved or created in the routine.</short>
</element>
<!-- procedure Visibility: default -->
<element name="DbgStopTimer">
<short>
Updates timing data using the specified name when it is stopped, and calculates its cumulative execution time.
</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="DbgStopTimer.AName">
<short>Name for the timing data updated in the routine.</short>
</element>
<!-- procedure Visibility: default -->
<element name="DbgStartMemWatch">
<short>
Gets or creates memory allocation data for the specified name, and initializes its data.
</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="DbgStartMemWatch.AName">
<short>Name for the memory allocation data updated in the routine.</short>
</element>
<!-- procedure Visibility: default -->
<element name="DbgStopMemWatch">
<short>
Updates memory allocation data using the specified name when it is stopped, and calculates its cumulative usage.
</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="DbgStopMemWatch.AName">
<short>Name for the associated memory allocation data updated in the routine.</short>
</element>
</module> <!-- LazLoggerProfiling -->
</package>
</fpdoc-descriptions>
|
