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
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
|
<HTML>
<HEAD>
<TITLE>LogStream 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="namespaceOpenMS_1_1Logger.html">Logger</a></li><li class="navelem"><a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html">LogStream</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pri-types">Private Types</a> |
<a href="#pri-methods">Private Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> |
<a href="classOpenMS_1_1Logger_1_1LogStream-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LogStream Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Log Stream Class.
<a href="classOpenMS_1_1Logger_1_1LogStream.html#details">More...</a></p>
<p><code>#include <<a class="el" href="LogStream_8h_source.html">OpenMS/CONCEPT/LogStream.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for LogStream:</div>
<div class="dyncontent">
<div class="center">
<img src="classOpenMS_1_1Logger_1_1LogStream.png" usemap="#LogStream_map" alt=""/>
<map id="LogStream_map" name="LogStream_map">
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors and Destructors</div></td></tr>
<tr class="memitem:a5179b973d6fb6085c9c267409ed78877"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html#a5179b973d6fb6085c9c267409ed78877">LogStream</a> (<a class="el" href="classOpenMS_1_1Logger_1_1LogStreamBuf.html">LogStreamBuf</a> *buf=0, bool delete_buf=true, std::ostream *stream=0)</td></tr>
<tr class="separator:a5179b973d6fb6085c9c267409ed78877"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf64a7836963963829cf35a931fc849f"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html#aaf64a7836963963829cf35a931fc849f">~LogStream</a> ()</td></tr>
<tr class="memdesc:aaf64a7836963963829cf35a931fc849f"><td class="mdescLeft"> </td><td class="mdescRight">Clears all message buffers. <a href="#aaf64a7836963963829cf35a931fc849f">More...</a><br/></td></tr>
<tr class="separator:aaf64a7836963963829cf35a931fc849f"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Stream Methods</div></td></tr>
<tr class="memitem:a50ef5d2bea80f487a164d772bf31350a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1Logger_1_1LogStreamBuf.html">LogStreamBuf</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html#a50ef5d2bea80f487a164d772bf31350a">rdbuf</a> ()</td></tr>
<tr class="separator:a50ef5d2bea80f487a164d772bf31350a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7351357e5b8d98b79e848a43e1cca156"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1Logger_1_1LogStreamBuf.html">LogStreamBuf</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html#a7351357e5b8d98b79e848a43e1cca156">operator-></a> ()</td></tr>
<tr class="memdesc:a7351357e5b8d98b79e848a43e1cca156"><td class="mdescLeft"> </td><td class="mdescRight">Arrow operator. <a href="#a7351357e5b8d98b79e848a43e1cca156">More...</a><br/></td></tr>
<tr class="separator:a7351357e5b8d98b79e848a43e1cca156"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Level methods</div></td></tr>
<tr class="memitem:aaefdf576666fce5063ca5e054ae4008f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html#aaefdf576666fce5063ca5e054ae4008f">setLevel</a> (std::string level)</td></tr>
<tr class="separator:aaefdf576666fce5063ca5e054ae4008f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac5de8300b41bfa13ed6c26b3b7870c85"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html#ac5de8300b41bfa13ed6c26b3b7870c85">getLevel</a> ()</td></tr>
<tr class="separator:ac5de8300b41bfa13ed6c26b3b7870c85"><td class="memSeparator" colspan="2"> </td></tr>
<tr><td colspan="2"><div class="groupHeader">Associating Streams</div></td></tr>
<tr class="memitem:a51e69405d3f8e4389356be36a14dc956"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html#a51e69405d3f8e4389356be36a14dc956">insert</a> (std::ostream &s)</td></tr>
<tr class="separator:a51e69405d3f8e4389356be36a14dc956"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac18a95fdfb75ebd58b3b4e727bbacfe0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html#ac18a95fdfb75ebd58b3b4e727bbacfe0">remove</a> (std::ostream &s)</td></tr>
<tr class="separator:ac18a95fdfb75ebd58b3b4e727bbacfe0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a95c7726c8d64b6d64310fc3da4e3b40e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html#a95c7726c8d64b6d64310fc3da4e3b40e">insertNotification</a> (std::ostream &s, <a class="el" href="classOpenMS_1_1Logger_1_1LogStreamNotifier.html">LogStreamNotifier</a> &target)</td></tr>
<tr class="memdesc:a95c7726c8d64b6d64310fc3da4e3b40e"><td class="mdescLeft"> </td><td class="mdescRight">Add a notification target. <a href="#a95c7726c8d64b6d64310fc3da4e3b40e">More...</a><br/></td></tr>
<tr class="separator:a95c7726c8d64b6d64310fc3da4e3b40e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ca325997ca4efb5081584792643cc9b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html#a7ca325997ca4efb5081584792643cc9b">setPrefix</a> (const std::ostream &s, const std::string &prefix)</td></tr>
<tr class="separator:a7ca325997ca4efb5081584792643cc9b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9fdca633333f524e073f31d7674ab1a8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html#a9fdca633333f524e073f31d7674ab1a8">setPrefix</a> (const std::string &prefix)</td></tr>
<tr class="memdesc:a9fdca633333f524e073f31d7674ab1a8"><td class="mdescLeft"> </td><td class="mdescRight">Set prefix of all output streams, details see setPrefix method with ostream. <a href="#a9fdca633333f524e073f31d7674ab1a8">More...</a><br/></td></tr>
<tr class="separator:a9fdca633333f524e073f31d7674ab1a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adac116554b543b7c4228c018a85882f5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html#adac116554b543b7c4228c018a85882f5">flush</a> ()</td></tr>
<tr class="separator:adac116554b543b7c4228c018a85882f5"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-types"></a>
Private Types</h2></td></tr>
<tr class="memitem:a6a6137914e01960149105083be5b755d"><td class="memItemLeft" align="right" valign="top">typedef std::list<br class="typebreak"/>
< <a class="el" href="structOpenMS_1_1Logger_1_1LogStreamBuf_1_1StreamStruct.html">LogStreamBuf::StreamStruct</a> ><br class="typebreak"/>
::iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html#a6a6137914e01960149105083be5b755d">StreamIterator</a></td></tr>
<tr class="separator:a6a6137914e01960149105083be5b755d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:af6db1db913759e214a9757e4d3f7fc32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html#a6a6137914e01960149105083be5b755d">StreamIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html#af6db1db913759e214a9757e4d3f7fc32">findStream_</a> (const std::ostream &stream)</td></tr>
<tr class="separator:af6db1db913759e214a9757e4d3f7fc32"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a01b4aff7f43305b848b485df45f44430"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html#a01b4aff7f43305b848b485df45f44430">hasStream_</a> (std::ostream &stream)</td></tr>
<tr class="separator:a01b4aff7f43305b848b485df45f44430"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8337eeedbf06cb8b136660fa6ec4434"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html#af8337eeedbf06cb8b136660fa6ec4434">bound_</a> () const </td></tr>
<tr class="separator:af8337eeedbf06cb8b136660fa6ec4434"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a83c16109983b0188079ddcfffdfa906b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html#a83c16109983b0188079ddcfffdfa906b">delete_buffer_</a></td></tr>
<tr class="separator:a83c16109983b0188079ddcfffdfa906b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Log Stream Class. </p>
<p>Defines a log stream which features a cache and some formatting. For the developer, however, only some macros are of interest which will push the message that follows them into the appropriate stream:</p>
<p>Macros:</p>
<ul>
<li>LOG_FATAL_ERROR</li>
<li>LOG_ERROR (non-fatal error are reported (processing continues))</li>
<li>LOG_WARN (warning, a piece of information which should be read by the user, should be logged)</li>
<li>LOG_INFO (information, e.g. a status should be reported)</li>
<li>LOG_DEBUG (general debugging information - output be written to cout if debug_level > 0)</li>
</ul>
<p>To use a specific logger of a log level simply use it as cerr or cout: <br/>
<code> LOG_ERROR << " A bad error occured ..." </code> <br/>
Which produces an error message in the log. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a6a6137914e01960149105083be5b755d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">typedef std::list<<a class="el" href="structOpenMS_1_1Logger_1_1LogStreamBuf_1_1StreamStruct.html">LogStreamBuf::StreamStruct</a>>::iterator <a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html#a6a6137914e01960149105083be5b755d">StreamIterator</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5179b973d6fb6085c9c267409ed78877"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html">LogStream</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOpenMS_1_1Logger_1_1LogStreamBuf.html">LogStreamBuf</a> * </td>
<td class="paramname"><em>buf</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>delete_buf</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::ostream * </td>
<td class="paramname"><em>stream</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new <a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html" title="Log Stream Class. ">LogStream</a> object that is not associated with any stream. If the argument <code>stream</code> is set to an output stream (e.g. <code>cout</code>) all output is send to that stream.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td></td></tr>
<tr><td class="paramname">delete_buf</td><td></td></tr>
<tr><td class="paramname">stream</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aaf64a7836963963829cf35a931fc849f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html">LogStream</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears all message buffers. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af8337eeedbf06cb8b136660fa6ec4434"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool bound_ </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="af6db1db913759e214a9757e4d3f7fc32"></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_1Logger_1_1LogStream.html#a6a6137914e01960149105083be5b755d">StreamIterator</a> findStream_ </td>
<td>(</td>
<td class="paramtype">const std::ostream & </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="adac116554b543b7c4228c018a85882f5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void flush </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ac5de8300b41bfa13ed6c26b3b7870c85"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string getLevel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the LogLevel of this <a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html" title="Log Stream Class. ">LogStream</a> </p>
</div>
</div>
<a class="anchor" id="a01b4aff7f43305b848b485df45f44430"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool hasStream_ </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>stream</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a51e69405d3f8e4389356be36a14dc956"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void insert </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Associate a new stream with this logstream. This method inserts a new stream into the list of associated streams and sets the corresponding minimum and maximum log levels. Any message that is subsequently logged, will be copied to this stream if its log level is between <code>min_level</code> and <code>max_level</code>. If <code>min_level</code> and <code>max_level</code> are omitted, all messages are copied to this stream. If <code>min_level</code> and <code>max_level</code> are equal, this function can be used to listen to a specified channel.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>a reference to the stream to be associated </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a95c7726c8d64b6d64310fc3da4e3b40e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void insertNotification </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classOpenMS_1_1Logger_1_1LogStreamNotifier.html">LogStreamNotifier</a> & </td>
<td class="paramname"><em>target</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a notification target. </p>
</div>
</div>
<a class="anchor" id="a7351357e5b8d98b79e848a43e1cca156"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1Logger_1_1LogStreamBuf.html">LogStreamBuf</a>* operator-> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Arrow operator. </p>
</div>
</div>
<a class="anchor" id="a50ef5d2bea80f487a164d772bf31350a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1Logger_1_1LogStreamBuf.html">LogStreamBuf</a>* rdbuf </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>rdbuf method of ostream. This method is needed to access the <a class="el" href="classOpenMS_1_1Logger_1_1LogStreamBuf.html" title="Stream buffer used by LogStream. ">LogStreamBuf</a> object.</p>
<dl class="section see"><dt>See Also</dt><dd>std::ostream::rdbuf for more details. </dd></dl>
</div>
</div>
<a class="anchor" id="ac18a95fdfb75ebd58b3b4e727bbacfe0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void remove </td>
<td>(</td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove an association with a stream.</p>
<p>Remove a stream from the stream list and avoid the copying of new messages to this stream. </p>
<dl class="section user"><dt></dt><dd>If the stream was not in the list of associated streams nothing will happen.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>the stream to be removed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aaefdf576666fce5063ca5e054ae4008f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setLevel </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>level</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the level of the <a class="el" href="classOpenMS_1_1Logger_1_1LogStream.html" title="Log Stream Class. ">LogStream</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">level</td><td>The new LogLevel </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7ca325997ca4efb5081584792643cc9b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setPrefix </td>
<td>(</td>
<td class="paramtype">const std::ostream & </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>prefix</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set prefix for output to this stream. Each line written to the stream will be prefixed by this string. The string may also contain trivial format specifiers to include loglevel and time/date of the logged message. </p>
<dl class="section user"><dt></dt><dd>The following format tags are recognized:</dd></dl>
<ul>
<li><b>y</b> message type ("Error", "Warning", "Information", "-")</li>
<li><b>T</b> time (HH:MM:SS)</li>
<li><b>t</b> time in short format (HH:MM)</li>
<li><b>D</b> date (YYYY/MM/DD)</li>
<li><b>d</b> date in short format (MM/DD)</li>
<li><b>S</b> time and date (YYYY/MM/DD, HH:MM:SS)</li>
<li><b>s</b> time and date in short format (MM/DD, HH:MM)</li>
<li><b>%%</b> percent sign (escape sequence)</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>The stream that will be prefixed. </td></tr>
<tr><td class="paramname">prefix</td><td>The prefix used for the stream. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9fdca633333f524e073f31d7674ab1a8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setPrefix </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>prefix</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set prefix of all output streams, details see setPrefix method with ostream. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a83c16109983b0188079ddcfffdfa906b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool delete_buffer_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>flag needed by the destructor to decide whether the streambuf has to be deleted. If the default ctor is used to create the <a class="el" href="classOpenMS_1_1Logger_1_1LogStreamBuf.html" title="Stream buffer used by LogStream. ">LogStreamBuf</a>, delete_buffer_ is set to true and the ctor also deletes the buffer. </p>
</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:38 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
