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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
|
<HTML>
<HEAD>
<TITLE>ProgressLogger Class Reference</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<A href="index.html">Home</A> ·
<A href="classes.html">Classes</A> ·
<A href="annotated.html">Annotated Classes</A> ·
<A href="modules.html">Modules</A> ·
<A href="functions_func.html">Members</A> ·
<A href="namespaces.html">Namespaces</A> ·
<A href="pages.html">Related Pages</A>
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<!-- Generated by Doxygen 1.8.5 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="classOpenMS_1_1ProgressLogger.html">ProgressLogger</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pro-static-attribs">Static Protected Attributes</a> |
<a href="classOpenMS_1_1ProgressLogger-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ProgressLogger Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Base class for all classes that want to report their progess.
<a href="classOpenMS_1_1ProgressLogger.html#details">More...</a></p>
<p><code>#include <<a class="el" href="ProgressLogger_8h_source.html">OpenMS/CONCEPT/ProgressLogger.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ProgressLogger:</div>
<div class="dyncontent">
<div class="center">
<img src="classOpenMS_1_1ProgressLogger.png" usemap="#ProgressLogger_map" alt=""/>
<map id="ProgressLogger_map" name="ProgressLogger_map">
<area href="classOpenMS_1_1AccurateMassSearchEngine.html" alt="AccurateMassSearchEngine" shape="rect" coords="421,56,832,80"/>
<area href="classOpenMS_1_1AverageLinkage.html" title="AverageLinkage ClusterMethod. " alt="AverageLinkage" shape="rect" coords="421,112,832,136"/>
<area href="classOpenMS_1_1BaseGroupFinder.html" title="The base class of all element group finding algorithms. " alt="BaseGroupFinder" shape="rect" coords="421,168,832,192"/>
<area href="classOpenMS_1_1BaseSuperimposer.html" title="The base class of all superimposer algorithms. " alt="BaseSuperimposer" shape="rect" coords="421,224,832,248"/>
<area href="classOpenMS_1_1CachedmzML.html" title="An class that uses on-disk caching to read and write spectra and chromatograms. " alt="CachedmzML" shape="rect" coords="421,280,832,304"/>
<area href="classOpenMS_1_1ChromatogramExtractor.html" title="The ChromatogramExtractor extracts chromatograms from a mzML file. " alt="ChromatogramExtractor" shape="rect" coords="421,336,832,360"/>
<area href="classOpenMS_1_1CompleteLinkage.html" title="CompleteLinkage ClusterMethod. " alt="CompleteLinkage" shape="rect" coords="421,392,832,416"/>
<area href="classOpenMS_1_1ConfidenceScoring.html" alt="ConfidenceScoring" shape="rect" coords="421,448,832,472"/>
<area href="classOpenMS_1_1ConsensusXMLFile.html" title="This class provides Input functionality for ConsensusMaps and Output functionality for alignments and..." alt="ConsensusXMLFile" shape="rect" coords="421,504,832,528"/>
<area href="classOpenMS_1_1DTA2DFile.html" title="DTA2D File adapter. " alt="DTA2DFile" shape="rect" coords="421,560,832,584"/>
<area href="classOpenMS_1_1ElutionPeakDetection.html" title="Extracts chromatographic peaks from a mass trace. " alt="ElutionPeakDetection" shape="rect" coords="421,616,832,640"/>
<area href="classOpenMS_1_1FeatureFinder.html" title="The main feature finder class. " alt="FeatureFinder" shape="rect" coords="421,672,832,696"/>
<area href="classOpenMS_1_1FeatureFindingMetabo.html" alt="FeatureFindingMetabo" shape="rect" coords="421,728,832,752"/>
<area href="classOpenMS_1_1FeatureXMLFile.html" title="This class provides Input/Output functionality for feature maps. " alt="FeatureXMLFile" shape="rect" coords="421,784,832,808"/>
<area href="classOpenMS_1_1GaussFilter.html" title="This class represents a Gaussian lowpass-filter which works on uniform as well as on non-uniform prof..." alt="GaussFilter" shape="rect" coords="421,840,832,864"/>
<area href="classOpenMS_1_1InternalCalibration.html" title="A simple calibration method using linear interpolation of given reference masses. ..." alt="InternalCalibration" shape="rect" coords="421,896,832,920"/>
<area href="classOpenMS_1_1IonizationSimulation.html" title="Simulates Protein ionization. " alt="IonizationSimulation" shape="rect" coords="421,952,832,976"/>
<area href="classOpenMS_1_1LinearResampler.html" title="Linear Resampling of raw data. " alt="LinearResampler" shape="rect" coords="421,1008,832,1032"/>
<area href="classOpenMS_1_1MapAlignmentAlgorithm.html" title="Base class for all map-alignment algorithms. " alt="MapAlignmentAlgorithm" shape="rect" coords="421,1064,832,1088"/>
<area href="classOpenMS_1_1MascotGenericFile.html" title="Mascot input file adapter. " alt="MascotGenericFile" shape="rect" coords="421,1120,832,1144"/>
<area href="classOpenMS_1_1MascotInfile.html" title="Mascot input file adapter. " alt="MascotInfile" shape="rect" coords="421,1176,832,1200"/>
<area href="classOpenMS_1_1MassTraceDetection.html" title="A mass trace extraction method that gathers peaks similar in m/z and moving along retention time..." alt="MassTraceDetection" shape="rect" coords="421,1232,832,1256"/>
<area href="classOpenMS_1_1MorphologicalFilter.html" title="This class implements baseline filtering operations using methods from mathematical morphology..." alt="MorphologicalFilter" shape="rect" coords="421,1288,832,1312"/>
<area href="classOpenMS_1_1MRMDecoy.html" title="This class generates a TargetedExperiment object with decoys based on a TargetedExperiment object..." alt="MRMDecoy" shape="rect" coords="421,1344,832,1368"/>
<area href="classOpenMS_1_1MRMFeatureFinderScoring.html" title="The MRMFeatureFinder finds and scores peaks of transitions that coelute. " alt="MRMFeatureFinderScoring" shape="rect" coords="421,1400,832,1424"/>
<area href="classOpenMS_1_1MS2File.html" title="MS2 input file adapter. " alt="MS2File" shape="rect" coords="421,1456,832,1480"/>
<area href="classOpenMS_1_1MSSim.html" title="Central class for simulation of mass spectrometry experiments. " alt="MSSim" shape="rect" coords="421,1512,832,1536"/>
<area href="classOpenMS_1_1MzDataFile.html" title="File adapter for MzData files. " alt="MzDataFile" shape="rect" coords="421,1568,832,1592"/>
<area href="classOpenMS_1_1MzIdentMLFile.html" title="File adapter for MzIdentML files. " alt="MzIdentMLFile" shape="rect" coords="421,1624,832,1648"/>
<area href="classOpenMS_1_1MzMLFile.html" title="File adapter for MzML files. " alt="MzMLFile" shape="rect" coords="421,1680,832,1704"/>
<area href="classOpenMS_1_1MzQuantMLFile.html" title="File adapter for MzQuantML files. " alt="MzQuantMLFile" shape="rect" coords="421,1736,832,1760"/>
<area href="classOpenMS_1_1MzXMLFile.html" title="File adapter for MzXML 2.1 files. " alt="MzXMLFile" shape="rect" coords="421,1792,832,1816"/>
<area href="classOpenMS_1_1PeakPickerCWT.html" title="This class implements a peak picking algorithm using wavelet techniques. " alt="PeakPickerCWT" shape="rect" coords="421,1848,832,1872"/>
<area href="classOpenMS_1_1PeakPickerHiRes.html" title="This class implements a fast peak-picking algorithm best suited for high resolution MS data (FT-ICR-M..." alt="PeakPickerHiRes" shape="rect" coords="421,1904,832,1928"/>
<area href="classOpenMS_1_1PeakPickerSH.html" alt="PeakPickerSH" shape="rect" coords="421,1960,832,1984"/>
<area href="classOpenMS_1_1QcMLFile.html" title="File adapter for QcML files. " alt="QcMLFile" shape="rect" coords="421,2016,832,2040"/>
<area href="classOpenMS_1_1RawMSSignalSimulation.html" title="Simulates MS signals for a given set of peptides. " alt="RawMSSignalSimulation" shape="rect" coords="421,2072,832,2096"/>
<area href="classOpenMS_1_1SavitzkyGolayFilter.html" title="Computes the Savitzky-Golay filter coefficients using QR decomposition. " alt="SavitzkyGolayFilter" shape="rect" coords="421,2128,832,2152"/>
<area href="classOpenMS_1_1SignalToNoiseEstimator.html" title="This class represents the abstract base class of a signal to noise estimator. " alt="SignalToNoiseEstimator< Container >" shape="rect" coords="421,2184,832,2208"/>
<area href="classOpenMS_1_1SILACAnalyzer.html" title="Algorithm to use for SILACAnalysis. " alt="SILACAnalyzer" shape="rect" coords="421,2240,832,2264"/>
<area href="classOpenMS_1_1SILACFiltering.html" title="Filtering for SILAC data. " alt="SILACFiltering" shape="rect" coords="421,2296,832,2320"/>
<area href="classOpenMS_1_1SingleLinkage.html" title="SingleLinkage ClusterMethod. " alt="SingleLinkage" shape="rect" coords="421,2352,832,2376"/>
<area href="classOpenMS_1_1SVMWrapper.html" title="Serves as a wrapper for the libsvm. " alt="SVMWrapper" shape="rect" coords="421,2408,832,2432"/>
<area href="classOpenMS_1_1TOFCalibration.html" title="This class implements an external calibration for TOF data using external calibrant spectra..." alt="TOFCalibration" shape="rect" coords="421,2464,832,2488"/>
<area href="classOpenMS_1_1ToolDescriptionFile.html" title="File adapter for ToolDescriptor files. " alt="ToolDescriptionFile" shape="rect" coords="421,2520,832,2544"/>
<area href="classOpenMS_1_1TraMLFile.html" title="File adapter for HUPO PSI TraML files. " alt="TraMLFile" shape="rect" coords="421,2576,832,2600"/>
<area href="classOpenMS_1_1TransitionTSVReader.html" title="This class can convert TraML and TSV files into each other. " alt="TransitionTSVReader" shape="rect" coords="421,2632,832,2656"/>
<area href="classOpenMS_1_1XMassFile.html" title="File adapter for 'XMass Analysis (fid)' files. " alt="XMassFile" shape="rect" coords="421,2688,832,2712"/>
<area href="classOpenMS_1_1SignalToNoiseEstimator.html" alt="SignalToNoiseEstimator< OpenMS::OpenMS::MSSpectrum< PeakT > >" shape="rect" coords="421,2744,832,2768"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:af67907baa897e9fb84df0cb89795b87c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#af67907baa897e9fb84df0cb89795b87c">LogType</a> { <a class="el" href="classOpenMS_1_1ProgressLogger.html#af67907baa897e9fb84df0cb89795b87ca3ab34dd50405af2d5a62627d572f7860">CMD</a>,
<a class="el" href="classOpenMS_1_1ProgressLogger.html#af67907baa897e9fb84df0cb89795b87ca73c6901c7c648a6a735770bc038bb26a">GUI</a>,
<a class="el" href="classOpenMS_1_1ProgressLogger.html#af67907baa897e9fb84df0cb89795b87cac157bdf0b85a40d2619cbc8bc1ae5fe2">NONE</a>
}</td></tr>
<tr class="memdesc:af67907baa897e9fb84df0cb89795b87c"><td class="mdescLeft"> </td><td class="mdescRight">Possible log types. <a href="classOpenMS_1_1ProgressLogger.html#af67907baa897e9fb84df0cb89795b87c">More...</a><br/></td></tr>
<tr class="separator:af67907baa897e9fb84df0cb89795b87c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2a106011aec95b2013d7a545f2063d01"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a2a106011aec95b2013d7a545f2063d01">ProgressLogger</a> ()</td></tr>
<tr class="memdesc:a2a106011aec95b2013d7a545f2063d01"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a2a106011aec95b2013d7a545f2063d01">More...</a><br/></td></tr>
<tr class="separator:a2a106011aec95b2013d7a545f2063d01"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a19c882d907f90f7f88c7436d82cd2a13"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a19c882d907f90f7f88c7436d82cd2a13">~ProgressLogger</a> ()</td></tr>
<tr class="memdesc:a19c882d907f90f7f88c7436d82cd2a13"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a19c882d907f90f7f88c7436d82cd2a13">More...</a><br/></td></tr>
<tr class="separator:a19c882d907f90f7f88c7436d82cd2a13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acc3538c5284777d8702ccaefeb61e74c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#acc3538c5284777d8702ccaefeb61e74c">setLogType</a> (<a class="el" href="classOpenMS_1_1ProgressLogger.html#af67907baa897e9fb84df0cb89795b87c">LogType</a> type) const </td></tr>
<tr class="memdesc:acc3538c5284777d8702ccaefeb61e74c"><td class="mdescLeft"> </td><td class="mdescRight">Sets the progress log that should be used. The default type is NONE! <a href="#acc3538c5284777d8702ccaefeb61e74c">More...</a><br/></td></tr>
<tr class="separator:acc3538c5284777d8702ccaefeb61e74c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a67024cdd5c34ec571baecabd8f783310"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1ProgressLogger.html#af67907baa897e9fb84df0cb89795b87c">LogType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a67024cdd5c34ec571baecabd8f783310">getLogType</a> () const </td></tr>
<tr class="memdesc:a67024cdd5c34ec571baecabd8f783310"><td class="mdescLeft"> </td><td class="mdescRight">Returns the type of progress log being used. <a href="#a67024cdd5c34ec571baecabd8f783310">More...</a><br/></td></tr>
<tr class="separator:a67024cdd5c34ec571baecabd8f783310"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af1c45ecd71b5041b70319249e8e73591"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#af1c45ecd71b5041b70319249e8e73591">startProgress</a> (<a class="el" href="group__Concept.html#gae113cb41304c6692c7bf5d0624dc6f0f">SignedSize</a> begin, <a class="el" href="group__Concept.html#gae113cb41304c6692c7bf5d0624dc6f0f">SignedSize</a> end, const <a class="el" href="classOpenMS_1_1String.html">String</a> &label) const </td></tr>
<tr class="memdesc:af1c45ecd71b5041b70319249e8e73591"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the progress display. <a href="#af1c45ecd71b5041b70319249e8e73591">More...</a><br/></td></tr>
<tr class="separator:af1c45ecd71b5041b70319249e8e73591"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8852277abd03220cc7b80d6c1bed6fed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a8852277abd03220cc7b80d6c1bed6fed">setProgress</a> (<a class="el" href="group__Concept.html#gae113cb41304c6692c7bf5d0624dc6f0f">SignedSize</a> value) const </td></tr>
<tr class="memdesc:a8852277abd03220cc7b80d6c1bed6fed"><td class="mdescLeft"> </td><td class="mdescRight">Sets the current progress. <a href="#a8852277abd03220cc7b80d6c1bed6fed">More...</a><br/></td></tr>
<tr class="separator:a8852277abd03220cc7b80d6c1bed6fed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1cc1012b0cdaea97f58d571af1ff45de"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a1cc1012b0cdaea97f58d571af1ff45de">endProgress</a> () const </td></tr>
<tr class="memdesc:a1cc1012b0cdaea97f58d571af1ff45de"><td class="mdescLeft"> </td><td class="mdescRight">Ends the progress display. <a href="#a1cc1012b0cdaea97f58d571af1ff45de">More...</a><br/></td></tr>
<tr class="separator:a1cc1012b0cdaea97f58d571af1ff45de"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a7c691d7de2a43bc5606e96cb15da3641"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1ProgressLogger.html#af67907baa897e9fb84df0cb89795b87c">LogType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a7c691d7de2a43bc5606e96cb15da3641">type_</a></td></tr>
<tr class="separator:a7c691d7de2a43bc5606e96cb15da3641"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a56589612e0e4164bf80c3918a087d05a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gae113cb41304c6692c7bf5d0624dc6f0f">SignedSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a56589612e0e4164bf80c3918a087d05a">begin_</a></td></tr>
<tr class="separator:a56589612e0e4164bf80c3918a087d05a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c749bf4e621699b7a5c45ae22c2fa90"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gae113cb41304c6692c7bf5d0624dc6f0f">SignedSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a0c749bf4e621699b7a5c45ae22c2fa90">end_</a></td></tr>
<tr class="separator:a0c749bf4e621699b7a5c45ae22c2fa90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec57b26e143202dc119a41592e075932"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gae113cb41304c6692c7bf5d0624dc6f0f">SignedSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#aec57b26e143202dc119a41592e075932">value_</a></td></tr>
<tr class="separator:aec57b26e143202dc119a41592e075932"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a76072b3919abcf01141ba68da8a001fd"><td class="memItemLeft" align="right" valign="top">QProgressDialog * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a76072b3919abcf01141ba68da8a001fd">dlg_</a></td></tr>
<tr class="separator:a76072b3919abcf01141ba68da8a001fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6d9750520313ea7f843d7a49cb2e9e5f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1StopWatch.html">StopWatch</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a6d9750520313ea7f843d7a49cb2e9e5f">stop_watch_</a></td></tr>
<tr class="separator:a6d9750520313ea7f843d7a49cb2e9e5f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a79bacf60c4109d7517590441c7f85f9c"><td class="memItemLeft" align="right" valign="top">time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a79bacf60c4109d7517590441c7f85f9c">last_invoke_</a></td></tr>
<tr class="separator:a79bacf60c4109d7517590441c7f85f9c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr class="memitem:a94eb3ef5ef94b83eb348dd00a2b53119"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a94eb3ef5ef94b83eb348dd00a2b53119">recursion_depth_</a></td></tr>
<tr class="separator:a94eb3ef5ef94b83eb348dd00a2b53119"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class for all classes that want to report their progess. </p>
<p>Per default the progress log is disabled. Use setLogType to enable it.</p>
<p>Use startProgress, setProgress and endProgress for the actual logging.</p>
<dl class="section note"><dt>Note</dt><dd>All methods are const, so it can be used through a const reference or in const methods as well! </dd></dl>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="af67907baa897e9fb84df0cb89795b87c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classOpenMS_1_1ProgressLogger.html#af67907baa897e9fb84df0cb89795b87c">LogType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Possible log types. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="af67907baa897e9fb84df0cb89795b87ca3ab34dd50405af2d5a62627d572f7860"></a>CMD</em> </td><td class="fielddoc">
<p>Command line progress. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="af67907baa897e9fb84df0cb89795b87ca73c6901c7c648a6a735770bc038bb26a"></a>GUI</em> </td><td class="fielddoc">
<p>Progress dialog. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="af67907baa897e9fb84df0cb89795b87cac157bdf0b85a40d2619cbc8bc1ae5fe2"></a>NONE</em> </td><td class="fielddoc">
<p>No progress logging. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a2a106011aec95b2013d7a545f2063d01"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1ProgressLogger.html">ProgressLogger</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<a class="anchor" id="a19c882d907f90f7f88c7436d82cd2a13"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classOpenMS_1_1ProgressLogger.html">ProgressLogger</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a1cc1012b0cdaea97f58d571af1ff45de"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void endProgress </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Ends the progress display. </p>
<p>Referenced by <a class="el" href="classOpenMS_1_1InternalCalibration.html#ae16f418bb5c7ac54002dce6c81a59ca3">InternalCalibration::calibrateMapGlobally()</a>, <a class="el" href="classOpenMS_1_1InternalCalibration.html#a1651981607d6c86252b9ab64e5f7996c">InternalCalibration::calibrateMapSpectrumwise()</a>, <a class="el" href="classOpenMS_1_1SignalToNoiseEstimatorMedian.html#a6a6102b4711d0d316cab9a78f492bc64">SignalToNoiseEstimatorMedian< OpenMS::OpenMS::MSSpectrum< PeakT > >::computeSTN_()</a>, <a class="el" href="classOpenMS_1_1SignalToNoiseEstimatorMeanIterative.html#aa216343e93fdf8b481569ae05d437dc4">SignalToNoiseEstimatorMeanIterative< Container >::computeSTN_()</a>, <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmSimplest.html#a72fcb26a14f6beb1c3fbace9ab3e7dbb">FeatureFinderAlgorithmSimplest< PeakType, FeatureType >::run()</a>, <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmSimple.html#a72fcb26a14f6beb1c3fbace9ab3e7dbb">FeatureFinderAlgorithmSimple< PeakType, FeatureType >::run()</a>, <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmPicked.html#a72fcb26a14f6beb1c3fbace9ab3e7dbb">FeatureFinderAlgorithmPicked< PeakType, FeatureType >::run()</a>, and <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmIsotopeWavelet.html#a13a43e6d814de94978c515cb084873b1">FeatureFinderAlgorithmIsotopeWavelet< OpenMS::Peak2D, FeatureType >::run()</a>.</p>
</div>
</div>
<a class="anchor" id="a67024cdd5c34ec571baecabd8f783310"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1ProgressLogger.html#af67907baa897e9fb84df0cb89795b87c">LogType</a> getLogType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the type of progress log being used. </p>
</div>
</div>
<a class="anchor" id="acc3538c5284777d8702ccaefeb61e74c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setLogType </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOpenMS_1_1ProgressLogger.html#af67907baa897e9fb84df0cb89795b87c">LogType</a> </td>
<td class="paramname"><em>type</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the progress log that should be used. The default type is NONE! </p>
<p>Referenced by <a class="el" href="classOpenMS_1_1FileHandler.html#a408091416e0e1f6019abd59bdb6a9269">FileHandler::loadExperiment()</a>, <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmIsotopeWavelet.html#a13a43e6d814de94978c515cb084873b1">FeatureFinderAlgorithmIsotopeWavelet< OpenMS::Peak2D, FeatureType >::run()</a>, <a class="el" href="classOpenMS_1_1TOPPViewBase.html#a923163eea1a103f7faaaa25b374e536a">TOPPViewBase::runTOPPTool_()</a>, and <a class="el" href="classOpenMS_1_1FileHandler.html#a4a8354ef45f8a0eac5a5038b3a025f37">FileHandler::storeExperiment()</a>.</p>
</div>
</div>
<a class="anchor" id="a8852277abd03220cc7b80d6c1bed6fed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setProgress </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Concept.html#gae113cb41304c6692c7bf5d0624dc6f0f">SignedSize</a> </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the current progress. </p>
<p>Referenced by <a class="el" href="classOpenMS_1_1InternalCalibration.html#ae16f418bb5c7ac54002dce6c81a59ca3">InternalCalibration::calibrateMapGlobally()</a>, <a class="el" href="classOpenMS_1_1InternalCalibration.html#a1651981607d6c86252b9ab64e5f7996c">InternalCalibration::calibrateMapSpectrumwise()</a>, <a class="el" href="classOpenMS_1_1SignalToNoiseEstimatorMedian.html#a6a6102b4711d0d316cab9a78f492bc64">SignalToNoiseEstimatorMedian< OpenMS::OpenMS::MSSpectrum< PeakT > >::computeSTN_()</a>, <a class="el" href="classOpenMS_1_1SignalToNoiseEstimatorMeanIterative.html#aa216343e93fdf8b481569ae05d437dc4">SignalToNoiseEstimatorMeanIterative< Container >::computeSTN_()</a>, <a class="el" href="classOpenMS_1_1SimpleSeeder.html#a9101eb2633f34b26a1436b3d8e1e7522">SimpleSeeder< PeakType, FeatureType >::nextSeed()</a>, <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmMRM.html#a72fcb26a14f6beb1c3fbace9ab3e7dbb">FeatureFinderAlgorithmMRM< PeakType, FeatureType >::run()</a>, <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmPicked.html#a72fcb26a14f6beb1c3fbace9ab3e7dbb">FeatureFinderAlgorithmPicked< PeakType, FeatureType >::run()</a>, and <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmIsotopeWavelet.html#a13a43e6d814de94978c515cb084873b1">FeatureFinderAlgorithmIsotopeWavelet< OpenMS::Peak2D, FeatureType >::run()</a>.</p>
</div>
</div>
<a class="anchor" id="af1c45ecd71b5041b70319249e8e73591"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void startProgress </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Concept.html#gae113cb41304c6692c7bf5d0624dc6f0f">SignedSize</a> </td>
<td class="paramname"><em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__Concept.html#gae113cb41304c6692c7bf5d0624dc6f0f">SignedSize</a> </td>
<td class="paramname"><em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> & </td>
<td class="paramname"><em>label</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the progress display. </p>
<p>Sets the progress range from <code>begin</code> to <code>end</code>. If <code>begin</code> equals <code>end</code>, setProgress only indicates that the program is still running, but without showing any absolute progress value.</p>
<p>Sets the label to <code>label</code>.</p>
<dl class="section note"><dt>Note</dt><dd>Make sure to call setLogType first! </dd></dl>
<p>Referenced by <a class="el" href="classOpenMS_1_1InternalCalibration.html#ae16f418bb5c7ac54002dce6c81a59ca3">InternalCalibration::calibrateMapGlobally()</a>, <a class="el" href="classOpenMS_1_1InternalCalibration.html#a1651981607d6c86252b9ab64e5f7996c">InternalCalibration::calibrateMapSpectrumwise()</a>, <a class="el" href="classOpenMS_1_1SignalToNoiseEstimatorMedian.html#a6a6102b4711d0d316cab9a78f492bc64">SignalToNoiseEstimatorMedian< OpenMS::OpenMS::MSSpectrum< PeakT > >::computeSTN_()</a>, <a class="el" href="classOpenMS_1_1SignalToNoiseEstimatorMeanIterative.html#aa216343e93fdf8b481569ae05d437dc4">SignalToNoiseEstimatorMeanIterative< Container >::computeSTN_()</a>, <a class="el" href="classOpenMS_1_1SimpleSeeder.html#a6aca068dd3cf1a6c7e78091c9bdae961">SimpleSeeder< PeakType, FeatureType >::initialize_()</a>, <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmMRM.html#a72fcb26a14f6beb1c3fbace9ab3e7dbb">FeatureFinderAlgorithmMRM< PeakType, FeatureType >::run()</a>, <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmPicked.html#a72fcb26a14f6beb1c3fbace9ab3e7dbb">FeatureFinderAlgorithmPicked< PeakType, FeatureType >::run()</a>, and <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmIsotopeWavelet.html#a13a43e6d814de94978c515cb084873b1">FeatureFinderAlgorithmIsotopeWavelet< OpenMS::Peak2D, FeatureType >::run()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a56589612e0e4164bf80c3918a087d05a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Concept.html#gae113cb41304c6692c7bf5d0624dc6f0f">SignedSize</a> begin_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a76072b3919abcf01141ba68da8a001fd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QProgressDialog* dlg_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a0c749bf4e621699b7a5c45ae22c2fa90"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Concept.html#gae113cb41304c6692c7bf5d0624dc6f0f">SignedSize</a> end_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a79bacf60c4109d7517590441c7f85f9c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">time_t last_invoke_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a94eb3ef5ef94b83eb348dd00a2b53119"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int recursion_depth_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a6d9750520313ea7f843d7a49cb2e9e5f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1StopWatch.html">StopWatch</a> stop_watch_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a7c691d7de2a43bc5606e96cb15da3641"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1ProgressLogger.html#af67907baa897e9fb84df0cb89795b87c">LogType</a> type_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aec57b26e143202dc119a41592e075932"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Concept.html#gae113cb41304c6692c7bf5d0624dc6f0f">SignedSize</a> value_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<TABLE width="100%" border="0">
<TR>
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:28 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
