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
535
536
537
538
539
540
|
<HTML>
<HEAD>
<TITLE>MetaInfo 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_1MetaInfo.html">MetaInfo</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> |
<a href="#pri-static-attribs">Static Private Attributes</a> |
<a href="classOpenMS_1_1MetaInfo-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">MetaInfo Class Reference<div class="ingroups"><a class="el" href="group__Metadata.html">Metadata</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A Type-Name-Value tuple class.
<a href="classOpenMS_1_1MetaInfo.html#details">More...</a></p>
<p><code>#include <<a class="el" href="MetaInfo_8h_source.html">OpenMS/METADATA/MetaInfo.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:aef8deedd002add9fa92b6776af338ddb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#aef8deedd002add9fa92b6776af338ddb">MetaInfo</a> ()</td></tr>
<tr class="memdesc:aef8deedd002add9fa92b6776af338ddb"><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#aef8deedd002add9fa92b6776af338ddb">More...</a><br/></td></tr>
<tr class="separator:aef8deedd002add9fa92b6776af338ddb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3225d7a354bbb3ad77731ef041dde098"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#a3225d7a354bbb3ad77731ef041dde098">MetaInfo</a> (const <a class="el" href="classOpenMS_1_1MetaInfo.html">MetaInfo</a> &rhs)</td></tr>
<tr class="memdesc:a3225d7a354bbb3ad77731ef041dde098"><td class="mdescLeft"> </td><td class="mdescRight">copy constructor <a href="#a3225d7a354bbb3ad77731ef041dde098">More...</a><br/></td></tr>
<tr class="separator:a3225d7a354bbb3ad77731ef041dde098"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45dd7f4ba59f2498a23be59ae563579a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#a45dd7f4ba59f2498a23be59ae563579a">~MetaInfo</a> ()</td></tr>
<tr class="memdesc:a45dd7f4ba59f2498a23be59ae563579a"><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="#a45dd7f4ba59f2498a23be59ae563579a">More...</a><br/></td></tr>
<tr class="separator:a45dd7f4ba59f2498a23be59ae563579a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1dbf7008b28977e2eac04f3f94c50bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1MetaInfo.html">MetaInfo</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#ae1dbf7008b28977e2eac04f3f94c50bb">operator=</a> (const <a class="el" href="classOpenMS_1_1MetaInfo.html">MetaInfo</a> &rhs)</td></tr>
<tr class="memdesc:ae1dbf7008b28977e2eac04f3f94c50bb"><td class="mdescLeft"> </td><td class="mdescRight">assignment operator <a href="#ae1dbf7008b28977e2eac04f3f94c50bb">More...</a><br/></td></tr>
<tr class="separator:ae1dbf7008b28977e2eac04f3f94c50bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f79054db71e8b0e68c5f89fc6916736"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#a9f79054db71e8b0e68c5f89fc6916736">operator==</a> (const <a class="el" href="classOpenMS_1_1MetaInfo.html">MetaInfo</a> &rhs) const </td></tr>
<tr class="memdesc:a9f79054db71e8b0e68c5f89fc6916736"><td class="mdescLeft"> </td><td class="mdescRight">Equality operator. <a href="#a9f79054db71e8b0e68c5f89fc6916736">More...</a><br/></td></tr>
<tr class="separator:a9f79054db71e8b0e68c5f89fc6916736"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a061a9c2c453ce4d2f2322af7672c8a78"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#a061a9c2c453ce4d2f2322af7672c8a78">operator!=</a> (const <a class="el" href="classOpenMS_1_1MetaInfo.html">MetaInfo</a> &rhs) const </td></tr>
<tr class="memdesc:a061a9c2c453ce4d2f2322af7672c8a78"><td class="mdescLeft"> </td><td class="mdescRight">Equality operator. <a href="#a061a9c2c453ce4d2f2322af7672c8a78">More...</a><br/></td></tr>
<tr class="separator:a061a9c2c453ce4d2f2322af7672c8a78"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a85dfe6b1d45c66dbab0f9c66f6b83f5a"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classOpenMS_1_1DataValue.html">DataValue</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#a85dfe6b1d45c66dbab0f9c66f6b83f5a">getValue</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &name) const </td></tr>
<tr class="memdesc:a85dfe6b1d45c66dbab0f9c66f6b83f5a"><td class="mdescLeft"> </td><td class="mdescRight">returns the value corresponding to a string <a href="#a85dfe6b1d45c66dbab0f9c66f6b83f5a">More...</a><br/></td></tr>
<tr class="separator:a85dfe6b1d45c66dbab0f9c66f6b83f5a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a614f065003dae44eb0898c38c5847184"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classOpenMS_1_1DataValue.html">DataValue</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#a614f065003dae44eb0898c38c5847184">getValue</a> (<a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a> index) const </td></tr>
<tr class="memdesc:a614f065003dae44eb0898c38c5847184"><td class="mdescLeft"> </td><td class="mdescRight">returns the value corresponding to an index <a href="#a614f065003dae44eb0898c38c5847184">More...</a><br/></td></tr>
<tr class="separator:a614f065003dae44eb0898c38c5847184"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a87d4b1cff4d2a7a32b605829e015f5ab"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#a87d4b1cff4d2a7a32b605829e015f5ab">exists</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &name) const </td></tr>
<tr class="memdesc:a87d4b1cff4d2a7a32b605829e015f5ab"><td class="mdescLeft"> </td><td class="mdescRight">returns if this <a class="el" href="classOpenMS_1_1MetaInfo.html" title="A Type-Name-Value tuple class. ">MetaInfo</a> is set <a href="#a87d4b1cff4d2a7a32b605829e015f5ab">More...</a><br/></td></tr>
<tr class="separator:a87d4b1cff4d2a7a32b605829e015f5ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a1532f255dece857508ed62260fa40d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#a0a1532f255dece857508ed62260fa40d">exists</a> (<a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a> index) const </td></tr>
<tr class="memdesc:a0a1532f255dece857508ed62260fa40d"><td class="mdescLeft"> </td><td class="mdescRight">returns if this <a class="el" href="classOpenMS_1_1MetaInfo.html" title="A Type-Name-Value tuple class. ">MetaInfo</a> is set <a href="#a0a1532f255dece857508ed62260fa40d">More...</a><br/></td></tr>
<tr class="separator:a0a1532f255dece857508ed62260fa40d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb7cdabed75dfe4317d39b7b908e2ae3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#abb7cdabed75dfe4317d39b7b908e2ae3">setValue</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &name, const <a class="el" href="classOpenMS_1_1DataValue.html">DataValue</a> &value)</td></tr>
<tr class="memdesc:abb7cdabed75dfe4317d39b7b908e2ae3"><td class="mdescLeft"> </td><td class="mdescRight">sets the <a class="el" href="classOpenMS_1_1DataValue.html" title="Class to hold strings, numeric values, lists of strings and lists of numeric values. ">DataValue</a> corresponding to a name <a href="#abb7cdabed75dfe4317d39b7b908e2ae3">More...</a><br/></td></tr>
<tr class="separator:abb7cdabed75dfe4317d39b7b908e2ae3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f610dac3f31bc5e71b78baa8e70430a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#a1f610dac3f31bc5e71b78baa8e70430a">setValue</a> (<a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a> index, const <a class="el" href="classOpenMS_1_1DataValue.html">DataValue</a> &value)</td></tr>
<tr class="memdesc:a1f610dac3f31bc5e71b78baa8e70430a"><td class="mdescLeft"> </td><td class="mdescRight">sets the <a class="el" href="classOpenMS_1_1DataValue.html" title="Class to hold strings, numeric values, lists of strings and lists of numeric values. ">DataValue</a> corresponding to an index <a href="#a1f610dac3f31bc5e71b78baa8e70430a">More...</a><br/></td></tr>
<tr class="separator:a1f610dac3f31bc5e71b78baa8e70430a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a20d82e3b0e195eea8583bf6e148f62f6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#a20d82e3b0e195eea8583bf6e148f62f6">removeValue</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &name)</td></tr>
<tr class="memdesc:a20d82e3b0e195eea8583bf6e148f62f6"><td class="mdescLeft"> </td><td class="mdescRight">Removes the <a class="el" href="classOpenMS_1_1DataValue.html" title="Class to hold strings, numeric values, lists of strings and lists of numeric values. ">DataValue</a> corresponding to <code>name</code> if it exists. <a href="#a20d82e3b0e195eea8583bf6e148f62f6">More...</a><br/></td></tr>
<tr class="separator:a20d82e3b0e195eea8583bf6e148f62f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a64a0bbb3ba21a0209dabb51116fbcbda"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#a64a0bbb3ba21a0209dabb51116fbcbda">removeValue</a> (<a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a> index)</td></tr>
<tr class="memdesc:a64a0bbb3ba21a0209dabb51116fbcbda"><td class="mdescLeft"> </td><td class="mdescRight">Removes the <a class="el" href="classOpenMS_1_1DataValue.html" title="Class to hold strings, numeric values, lists of strings and lists of numeric values. ">DataValue</a> corresponding to <code>index</code> if it exists. <a href="#a64a0bbb3ba21a0209dabb51116fbcbda">More...</a><br/></td></tr>
<tr class="separator:a64a0bbb3ba21a0209dabb51116fbcbda"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaefa2a4a5d50f899cdd82d686104d164"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#aaefa2a4a5d50f899cdd82d686104d164">getKeys</a> (std::vector< <a class="el" href="classOpenMS_1_1String.html">String</a> > &keys) const </td></tr>
<tr class="memdesc:aaefa2a4a5d50f899cdd82d686104d164"><td class="mdescLeft"> </td><td class="mdescRight">fills the given vector with a list of all keys for which a value is set <a href="#aaefa2a4a5d50f899cdd82d686104d164">More...</a><br/></td></tr>
<tr class="separator:aaefa2a4a5d50f899cdd82d686104d164"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a121b22fe4dd05ef9fc4160bd52e9bd0b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#a121b22fe4dd05ef9fc4160bd52e9bd0b">getKeys</a> (std::vector< <a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a> > &keys) const </td></tr>
<tr class="memdesc:a121b22fe4dd05ef9fc4160bd52e9bd0b"><td class="mdescLeft"> </td><td class="mdescRight">fills the given vector with a list of all keys for which a value is set <a href="#a121b22fe4dd05ef9fc4160bd52e9bd0b">More...</a><br/></td></tr>
<tr class="separator:a121b22fe4dd05ef9fc4160bd52e9bd0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac6e61de369e994009e36f344f99c15ad"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#ac6e61de369e994009e36f344f99c15ad">empty</a> () const </td></tr>
<tr class="memdesc:ac6e61de369e994009e36f344f99c15ad"><td class="mdescLeft"> </td><td class="mdescRight">returns if the <a class="el" href="classOpenMS_1_1MetaInfo.html" title="A Type-Name-Value tuple class. ">MetaInfo</a> is empty <a href="#ac6e61de369e994009e36f344f99c15ad">More...</a><br/></td></tr>
<tr class="separator:ac6e61de369e994009e36f344f99c15ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8bb3912a3ce86b15842e79d0b421204"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr>
<tr class="memdesc:ac8bb3912a3ce86b15842e79d0b421204"><td class="mdescLeft"> </td><td class="mdescRight">removes all meta values <a href="#ac8bb3912a3ce86b15842e79d0b421204">More...</a><br/></td></tr>
<tr class="separator:ac8bb3912a3ce86b15842e79d0b421204"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:abff2063b24c8e80dd783dacaaadbba5b"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classOpenMS_1_1MetaInfoRegistry.html">MetaInfoRegistry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#abff2063b24c8e80dd783dacaaadbba5b">registry</a> ()</td></tr>
<tr class="memdesc:abff2063b24c8e80dd783dacaaadbba5b"><td class="mdescLeft"> </td><td class="mdescRight">returns a reference to the <a class="el" href="classOpenMS_1_1MetaInfoRegistry.html" title="Registry which assigns unique integer indices to strings. ">MetaInfoRegistry</a> <a href="#abff2063b24c8e80dd783dacaaadbba5b">More...</a><br/></td></tr>
<tr class="separator:abff2063b24c8e80dd783dacaaadbba5b"><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:a5c209784342fd7f0c652260da049bc8f"><td class="memItemLeft" align="right" valign="top">std::map< <a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a>, <a class="el" href="classOpenMS_1_1DataValue.html">DataValue</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#a5c209784342fd7f0c652260da049bc8f">index_to_value_</a></td></tr>
<tr class="memdesc:a5c209784342fd7f0c652260da049bc8f"><td class="mdescLeft"> </td><td class="mdescRight">the actual mapping of index to the <a class="el" href="classOpenMS_1_1DataValue.html" title="Class to hold strings, numeric values, lists of strings and lists of numeric values. ">DataValue</a> <a href="#a5c209784342fd7f0c652260da049bc8f">More...</a><br/></td></tr>
<tr class="separator:a5c209784342fd7f0c652260da049bc8f"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr class="memitem:ac5710c7c15e26d6715e40dac27f28297"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classOpenMS_1_1MetaInfoRegistry.html">MetaInfoRegistry</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MetaInfo.html#ac5710c7c15e26d6715e40dac27f28297">registry_</a></td></tr>
<tr class="memdesc:ac5710c7c15e26d6715e40dac27f28297"><td class="mdescLeft"> </td><td class="mdescRight">static <a class="el" href="classOpenMS_1_1MetaInfoRegistry.html" title="Registry which assigns unique integer indices to strings. ">MetaInfoRegistry</a> <a href="#ac5710c7c15e26d6715e40dac27f28297">More...</a><br/></td></tr>
<tr class="separator:ac5710c7c15e26d6715e40dac27f28297"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A Type-Name-Value tuple class. </p>
<p><a class="el" href="classOpenMS_1_1MetaInfo.html" title="A Type-Name-Value tuple class. ">MetaInfo</a> maps an index ( an integer corresponding to a string ) to <a class="el" href="classOpenMS_1_1DataValue.html" title="Class to hold strings, numeric values, lists of strings and lists of numeric values. ">DataValue</a> objects. The mapping of strings to the index is perfomed by the <a class="el" href="classOpenMS_1_1MetaInfoRegistry.html" title="Registry which assigns unique integer indices to strings. ">MetaInfoRegistry</a>, which can be accessed by the method <a class="el" href="classOpenMS_1_1MetaInfo.html#abff2063b24c8e80dd783dacaaadbba5b" title="returns a reference to the MetaInfoRegistry ">registry()</a>.</p>
<p>There are two versions of nearly all members. One which operates with a string name and another one which operates on an index. The index version is always faster, as it does not need to look up the index corresponding to the the string in the <a class="el" href="classOpenMS_1_1MetaInfoRegistry.html" title="Registry which assigns unique integer indices to strings. ">MetaInfoRegistry</a>.</p>
<p>If you wish to add one <a class="el" href="classOpenMS_1_1MetaInfo.html" title="A Type-Name-Value tuple class. ">MetaInfo</a> member to a class, consider deriving that class from <a class="el" href="classOpenMS_1_1MetaInfoInterface.html" title="Interface for classes that can store arbitrary meta information (Type-Name-Value tuples). ">MetaInfoInterface</a>, instead of simply adding <a class="el" href="classOpenMS_1_1MetaInfo.html" title="A Type-Name-Value tuple class. ">MetaInfo</a> as member. <a class="el" href="classOpenMS_1_1MetaInfoInterface.html" title="Interface for classes that can store arbitrary meta information (Type-Name-Value tuples). ">MetaInfoInterface</a> implements a full interface to a <a class="el" href="classOpenMS_1_1MetaInfo.html" title="A Type-Name-Value tuple class. ">MetaInfo</a> member. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="aef8deedd002add9fa92b6776af338ddb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1MetaInfo.html">MetaInfo</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="a3225d7a354bbb3ad77731ef041dde098"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1MetaInfo.html">MetaInfo</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1MetaInfo.html">MetaInfo</a> & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>copy constructor </p>
</div>
</div>
<a class="anchor" id="a45dd7f4ba59f2498a23be59ae563579a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classOpenMS_1_1MetaInfo.html">MetaInfo</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="ac8bb3912a3ce86b15842e79d0b421204"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>removes all meta values </p>
</div>
</div>
<a class="anchor" id="ac6e61de369e994009e36f344f99c15ad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool empty </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>returns if the <a class="el" href="classOpenMS_1_1MetaInfo.html" title="A Type-Name-Value tuple class. ">MetaInfo</a> is empty </p>
</div>
</div>
<a class="anchor" id="a87d4b1cff4d2a7a32b605829e015f5ab"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool exists </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>returns if this <a class="el" href="classOpenMS_1_1MetaInfo.html" title="A Type-Name-Value tuple class. ">MetaInfo</a> is set </p>
</div>
</div>
<a class="anchor" id="a0a1532f255dece857508ed62260fa40d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool exists </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a> </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>returns if this <a class="el" href="classOpenMS_1_1MetaInfo.html" title="A Type-Name-Value tuple class. ">MetaInfo</a> is set </p>
</div>
</div>
<a class="anchor" id="aaefa2a4a5d50f899cdd82d686104d164"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void getKeys </td>
<td>(</td>
<td class="paramtype">std::vector< <a class="el" href="classOpenMS_1_1String.html">String</a> > & </td>
<td class="paramname"><em>keys</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>fills the given vector with a list of all keys for which a value is set </p>
</div>
</div>
<a class="anchor" id="a121b22fe4dd05ef9fc4160bd52e9bd0b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void getKeys </td>
<td>(</td>
<td class="paramtype">std::vector< <a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a> > & </td>
<td class="paramname"><em>keys</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>fills the given vector with a list of all keys for which a value is set </p>
</div>
</div>
<a class="anchor" id="a85dfe6b1d45c66dbab0f9c66f6b83f5a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classOpenMS_1_1DataValue.html">DataValue</a>& getValue </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>returns the value corresponding to a string </p>
</div>
</div>
<a class="anchor" id="a614f065003dae44eb0898c38c5847184"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classOpenMS_1_1DataValue.html">DataValue</a>& getValue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a> </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>returns the value corresponding to an index </p>
</div>
</div>
<a class="anchor" id="a061a9c2c453ce4d2f2322af7672c8a78"></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_1MetaInfo.html">MetaInfo</a> & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Equality operator. </p>
</div>
</div>
<a class="anchor" id="ae1dbf7008b28977e2eac04f3f94c50bb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1MetaInfo.html">MetaInfo</a>& operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1MetaInfo.html">MetaInfo</a> & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>assignment operator </p>
</div>
</div>
<a class="anchor" id="a9f79054db71e8b0e68c5f89fc6916736"></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_1MetaInfo.html">MetaInfo</a> & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Equality operator. </p>
</div>
</div>
<a class="anchor" id="abff2063b24c8e80dd783dacaaadbba5b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classOpenMS_1_1MetaInfoRegistry.html">MetaInfoRegistry</a>& registry </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>returns a reference to the <a class="el" href="classOpenMS_1_1MetaInfoRegistry.html" title="Registry which assigns unique integer indices to strings. ">MetaInfoRegistry</a> </p>
</div>
</div>
<a class="anchor" id="a20d82e3b0e195eea8583bf6e148f62f6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void removeValue </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes the <a class="el" href="classOpenMS_1_1DataValue.html" title="Class to hold strings, numeric values, lists of strings and lists of numeric values. ">DataValue</a> corresponding to <code>name</code> if it exists. </p>
</div>
</div>
<a class="anchor" id="a64a0bbb3ba21a0209dabb51116fbcbda"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void removeValue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a> </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes the <a class="el" href="classOpenMS_1_1DataValue.html" title="Class to hold strings, numeric values, lists of strings and lists of numeric values. ">DataValue</a> corresponding to <code>index</code> if it exists. </p>
</div>
</div>
<a class="anchor" id="abb7cdabed75dfe4317d39b7b908e2ae3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setValue </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> & </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1DataValue.html">DataValue</a> & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>sets the <a class="el" href="classOpenMS_1_1DataValue.html" title="Class to hold strings, numeric values, lists of strings and lists of numeric values. ">DataValue</a> corresponding to a name </p>
</div>
</div>
<a class="anchor" id="a1f610dac3f31bc5e71b78baa8e70430a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setValue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a> </td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1DataValue.html">DataValue</a> & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>sets the <a class="el" href="classOpenMS_1_1DataValue.html" title="Class to hold strings, numeric values, lists of strings and lists of numeric values. ">DataValue</a> corresponding to an index </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a5c209784342fd7f0c652260da049bc8f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::map<<a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a>, <a class="el" href="classOpenMS_1_1DataValue.html">DataValue</a>> index_to_value_</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>the actual mapping of index to the <a class="el" href="classOpenMS_1_1DataValue.html" title="Class to hold strings, numeric values, lists of strings and lists of numeric values. ">DataValue</a> </p>
</div>
</div>
<a class="anchor" id="ac5710c7c15e26d6715e40dac27f28297"></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_1MetaInfoRegistry.html">MetaInfoRegistry</a> registry_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>static <a class="el" href="classOpenMS_1_1MetaInfoRegistry.html" title="Registry which assigns unique integer indices to strings. ">MetaInfoRegistry</a> </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:33 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
