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
|
<HTML>
<HEAD>
<TITLE>DocumentIDTagger 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_1DocumentIDTagger.html">DocumentIDTagger</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pri-methods">Private Member Functions</a> |
<a href="classOpenMS_1_1DocumentIDTagger-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">DocumentIDTagger Class Reference<div class="ingroups"><a class="el" href="group__Metadata.html">Metadata</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Tags <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> file containers with a DocumentID.
<a href="classOpenMS_1_1DocumentIDTagger.html#details">More...</a></p>
<p><code>#include <<a class="el" href="DocumentIDTagger_8h_source.html">OpenMS/METADATA/DocumentIDTagger.h</a>></code></p>
<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:a6baf8ed1574c57767e904d42acc2e641"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html#a6baf8ed1574c57767e904d42acc2e641">DocumentIDTagger</a> (<a class="el" href="classOpenMS_1_1String.html">String</a> toolname)</td></tr>
<tr class="memdesc:a6baf8ed1574c57767e904d42acc2e641"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a6baf8ed1574c57767e904d42acc2e641">More...</a><br/></td></tr>
<tr class="separator:a6baf8ed1574c57767e904d42acc2e641"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab4da81bf157b2d1f1b3a87e4e58999b5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html#ab4da81bf157b2d1f1b3a87e4e58999b5">DocumentIDTagger</a> (const <a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a> &source)</td></tr>
<tr class="memdesc:ab4da81bf157b2d1f1b3a87e4e58999b5"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#ab4da81bf157b2d1f1b3a87e4e58999b5">More...</a><br/></td></tr>
<tr class="separator:ab4da81bf157b2d1f1b3a87e4e58999b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab4992186dec84998a7cd9ea6b27878c7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html#ab4992186dec84998a7cd9ea6b27878c7">~DocumentIDTagger</a> ()</td></tr>
<tr class="memdesc:ab4992186dec84998a7cd9ea6b27878c7"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ab4992186dec84998a7cd9ea6b27878c7">More...</a><br/></td></tr>
<tr class="separator:ab4992186dec84998a7cd9ea6b27878c7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a62bed24c0268915010c1b0d89ea82d3c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html#a62bed24c0268915010c1b0d89ea82d3c">operator=</a> (const <a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a> &source)</td></tr>
<tr class="memdesc:a62bed24c0268915010c1b0d89ea82d3c"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#a62bed24c0268915010c1b0d89ea82d3c">More...</a><br/></td></tr>
<tr class="separator:a62bed24c0268915010c1b0d89ea82d3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8a0a7dc275ff436efde201c3d2322eff"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html#a8a0a7dc275ff436efde201c3d2322eff">operator==</a> (const <a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a> &source) const </td></tr>
<tr class="memdesc:a8a0a7dc275ff436efde201c3d2322eff"><td class="mdescLeft"> </td><td class="mdescRight">Equality operator. <a href="#a8a0a7dc275ff436efde201c3d2322eff">More...</a><br/></td></tr>
<tr class="separator:a8a0a7dc275ff436efde201c3d2322eff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a41d9130262cc1b870b7dae7c9a04d535"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html#a41d9130262cc1b870b7dae7c9a04d535">operator!=</a> (const <a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a> &source) const </td></tr>
<tr class="memdesc:a41d9130262cc1b870b7dae7c9a04d535"><td class="mdescLeft"> </td><td class="mdescRight">Equality operator. <a href="#a41d9130262cc1b870b7dae7c9a04d535">More...</a><br/></td></tr>
<tr class="separator:a41d9130262cc1b870b7dae7c9a04d535"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a700459da9be549759a0147e8049e2cb4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html#a700459da9be549759a0147e8049e2cb4">getPoolFile</a> () const </td></tr>
<tr class="memdesc:a700459da9be549759a0147e8049e2cb4"><td class="mdescLeft"> </td><td class="mdescRight">Return the file used as ID pool. <a href="#a700459da9be549759a0147e8049e2cb4">More...</a><br/></td></tr>
<tr class="separator:a700459da9be549759a0147e8049e2cb4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a17f77efff59d80ffa4d1296a8e1b6eef"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html#a17f77efff59d80ffa4d1296a8e1b6eef">setPoolFile</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &file)</td></tr>
<tr class="memdesc:a17f77efff59d80ffa4d1296a8e1b6eef"><td class="mdescLeft"> </td><td class="mdescRight">Set the file used as ID pool. <a href="#a17f77efff59d80ffa4d1296a8e1b6eef">More...</a><br/></td></tr>
<tr class="separator:a17f77efff59d80ffa4d1296a8e1b6eef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a26dcd47cc5aeecd27330b7813b6056b2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html#a26dcd47cc5aeecd27330b7813b6056b2">tag</a> (<a class="el" href="classOpenMS_1_1DocumentIdentifier.html">DocumentIdentifier</a> &map) const </td></tr>
<tr class="memdesc:a26dcd47cc5aeecd27330b7813b6056b2"><td class="mdescLeft"> </td><td class="mdescRight">Tags any structure which is derived from <a class="el" href="classOpenMS_1_1DocumentIdentifier.html" title="Manage source document information. ">DocumentIdentifier</a> with a unique tag. <a href="#a26dcd47cc5aeecd27330b7813b6056b2">More...</a><br/></td></tr>
<tr class="separator:a26dcd47cc5aeecd27330b7813b6056b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5645b19947f67e4a944d4299d2196f6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html#aa5645b19947f67e4a944d4299d2196f6">countFreeIDs</a> (<a class="el" href="group__Concept.html#ga7cc214a236ad3bb6ad435bdcf5262a3f">Int</a> &free) const </td></tr>
<tr class="memdesc:aa5645b19947f67e4a944d4299d2196f6"><td class="mdescLeft"> </td><td class="mdescRight">return the number of available IDs in the pool. <a href="#aa5645b19947f67e4a944d4299d2196f6">More...</a><br/></td></tr>
<tr class="separator:aa5645b19947f67e4a944d4299d2196f6"><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:a4fb4db0bd3d688c678693d825fe0147f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html#a4fb4db0bd3d688c678693d825fe0147f">toolname_</a></td></tr>
<tr class="memdesc:a4fb4db0bd3d688c678693d825fe0147f"><td class="mdescLeft"> </td><td class="mdescRight">name of the calling TOPP tool <a href="#a4fb4db0bd3d688c678693d825fe0147f">More...</a><br/></td></tr>
<tr class="separator:a4fb4db0bd3d688c678693d825fe0147f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10cf1f48bfc918d728b4d15ee95165a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html#a10cf1f48bfc918d728b4d15ee95165a0">pool_file_</a></td></tr>
<tr class="memdesc:a10cf1f48bfc918d728b4d15ee95165a0"><td class="mdescLeft"> </td><td class="mdescRight">location of the ID pool <a href="#a10cf1f48bfc918d728b4d15ee95165a0">More...</a><br/></td></tr>
<tr class="separator:a10cf1f48bfc918d728b4d15ee95165a0"><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:a0f26016a2e53abdf49c958c8e5f13178"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html#a0f26016a2e53abdf49c958c8e5f13178">DocumentIDTagger</a> ()</td></tr>
<tr class="memdesc:a0f26016a2e53abdf49c958c8e5f13178"><td class="mdescLeft"> </td><td class="mdescRight">Constructor (declared away) <a href="#a0f26016a2e53abdf49c958c8e5f13178">More...</a><br/></td></tr>
<tr class="separator:a0f26016a2e53abdf49c958c8e5f13178"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a5facda334ec0e5bd2c3dc677c8d758"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html#a2a5facda334ec0e5bd2c3dc677c8d758">getID_</a> (<a class="el" href="classOpenMS_1_1String.html">String</a> &id, <a class="el" href="group__Concept.html#ga7cc214a236ad3bb6ad435bdcf5262a3f">Int</a> &free, bool idcount_only) const </td></tr>
<tr class="memdesc:a2a5facda334ec0e5bd2c3dc677c8d758"><td class="mdescLeft"> </td><td class="mdescRight">retrieve an ID from the pool <a href="#a2a5facda334ec0e5bd2c3dc677c8d758">More...</a><br/></td></tr>
<tr class="separator:a2a5facda334ec0e5bd2c3dc677c8d758"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Tags <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> file containers with a DocumentID. </p>
<p>Intended usage is from within a TOPP tool. An instance of this class is present in <a class="el" href="classOpenMS_1_1TOPPBase.html" title="Base class for TOPP applications. ">TOPPBase</a> and can be used by all derived TOPP tools to assign a unique ID which is fetched from an ID pool in ./share/OpenMS/IDPool/. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a0f26016a2e53abdf49c958c8e5f13178"></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_1DocumentIDTagger.html">DocumentIDTagger</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">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor (declared away) </p>
</div>
</div>
<a class="anchor" id="a6baf8ed1574c57767e904d42acc2e641"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOpenMS_1_1String.html">String</a> </td>
<td class="paramname"><em>toolname</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<a class="anchor" id="ab4da81bf157b2d1f1b3a87e4e58999b5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a> & </td>
<td class="paramname"><em>source</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
</div>
</div>
<a class="anchor" id="ab4992186dec84998a7cd9ea6b27878c7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</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="aa5645b19947f67e4a944d4299d2196f6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool countFreeIDs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Concept.html#ga7cc214a236ad3bb6ad435bdcf5262a3f">Int</a> & </td>
<td class="paramname"><em>free</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>return the number of available IDs in the pool. </p>
<p>Retrieve the number of available IDs in the pool. Returns true of count was successful, false otherwise (locking error, file creation error ...)</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">free</td><td>Number of available identifiers. You should worry if it's 0! </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2a5facda334ec0e5bd2c3dc677c8d758"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool getID_ </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOpenMS_1_1String.html">String</a> & </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__Concept.html#ga7cc214a236ad3bb6ad435bdcf5262a3f">Int</a> & </td>
<td class="paramname"><em>free</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>idcount_only</em> </td>
</tr>
<tr>
<td></td>
<td>)</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">
<p>retrieve an ID from the pool </p>
<p>Uses boost filelocks to safely retrieve an ID from an ID pool.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>Unique identifier returned from ID pool </td></tr>
<tr><td class="paramname">free</td><td>Number of available identifiers in ID pool (before this query) </td></tr>
<tr><td class="paramname">idcount_only</td><td>Only count available identifiers, do NOT retrieve one (the id string will nevertheless be filled)</td></tr>
</table>
</dd>
</dl>
<p>Return true if all file operations could be executed successfully (this does not imply there was an ID left over - check free>0) </p>
</div>
</div>
<a class="anchor" id="a700459da9be549759a0147e8049e2cb4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1String.html">String</a> getPoolFile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the file used as ID pool. </p>
<p>The default ID pool file is in /share/OpenMS/IDPool/IDPool.txt A custom file can be set by setIDPoolFile() </p>
</div>
</div>
<a class="anchor" id="a41d9130262cc1b870b7dae7c9a04d535"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a> & </td>
<td class="paramname"><em>source</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Equality operator. </p>
</div>
</div>
<a class="anchor" id="a62bed24c0268915010c1b0d89ea82d3c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a>& operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a> & </td>
<td class="paramname"><em>source</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Assignment operator. </p>
</div>
</div>
<a class="anchor" id="a8a0a7dc275ff436efde201c3d2322eff"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a> & </td>
<td class="paramname"><em>source</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Equality operator. </p>
</div>
</div>
<a class="anchor" id="a17f77efff59d80ffa4d1296a8e1b6eef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setPoolFile </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> & </td>
<td class="paramname"><em>file</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the file used as ID pool. </p>
</div>
</div>
<a class="anchor" id="a26dcd47cc5aeecd27330b7813b6056b2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool tag </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOpenMS_1_1DocumentIdentifier.html">DocumentIdentifier</a> & </td>
<td class="paramname"><em>map</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Tags any structure which is derived from <a class="el" href="classOpenMS_1_1DocumentIdentifier.html" title="Manage source document information. ">DocumentIdentifier</a> with a unique tag. </p>
<p>Tags any structure which is derived from <a class="el" href="classOpenMS_1_1DocumentIdentifier.html" title="Manage source document information. ">DocumentIdentifier</a> with a unique tag Returns true if ID could be assigned, otherwise an <a class="el" href="classOpenMS_1_1Exception_1_1DepletedIDPool.html" title="Exception used if no more unique document ID's can be drawn from ID pool. ">Exception::DepletedIDPool</a> is thrown</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">map</td><td>Some class (derived from a <a class="el" href="classOpenMS_1_1DocumentIdentifier.html" title="Manage source document information. ">DocumentIdentifier</a> class) which needs a unique id </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classOpenMS_1_1Exception_1_1DepletedIDPool.html" title="Exception used if no more unique document ID's can be drawn from ID pool. ">Exception::DepletedIDPool</a></td><td>when no identifier (for whatever reason) could be aquired </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a10cf1f48bfc918d728b4d15ee95165a0"></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_1String.html">String</a> pool_file_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>location of the ID pool </p>
</div>
</div>
<a class="anchor" id="a4fb4db0bd3d688c678693d825fe0147f"></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_1String.html">String</a> toolname_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>name of the calling TOPP tool </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:32 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
