~ubuntu-branches/ubuntu/wily/openms/wily

« back to all changes in this revision

Viewing changes to doc/html/classOpenMS_1_1DocumentIDTagger.html

  • Committer: Package Import Robot
  • Author(s): Filippo Rusconi
  • Date: 2013-12-20 11:30:16 UTC
  • mfrom: (5.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20131220113016-wre5g9bteeheq6he
Tags: 1.11.1-3
* remove version number from libbost development package names;
* ensure that AUTHORS is correctly shipped in all packages.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<HTML>
 
2
<HEAD>
 
3
<TITLE>DocumentIDTagger Class Reference</TITLE>
 
4
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
 
5
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
 
6
</HEAD>
 
7
<BODY BGCOLOR="#FFFFFF">
 
8
<A href="index.html">Home</A> &nbsp;&middot;
 
9
<A href="classes.html">Classes</A> &nbsp;&middot;
 
10
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
 
11
<A href="modules.html">Modules</A> &nbsp;&middot;
 
12
<A href="functions_func.html">Members</A> &nbsp;&middot;
 
13
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
 
14
<A href="pages.html">Related Pages</A>
 
15
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
16
<!-- Generated by Doxygen 1.8.5 -->
 
17
<div id="nav-path" class="navpath">
 
18
  <ul>
 
19
<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>
 
20
</div>
 
21
</div><!-- top -->
 
22
<div class="header">
 
23
  <div class="summary">
 
24
<a href="#pub-methods">Public Member Functions</a> &#124;
 
25
<a href="#pro-attribs">Protected Attributes</a> &#124;
 
26
<a href="#pri-methods">Private Member Functions</a> &#124;
 
27
<a href="classOpenMS_1_1DocumentIDTagger-members.html">List of all members</a>  </div>
 
28
  <div class="headertitle">
 
29
<div class="title">DocumentIDTagger Class Reference<div class="ingroups"><a class="el" href="group__Metadata.html">Metadata</a></div></div>  </div>
 
30
</div><!--header-->
 
31
<div class="contents">
 
32
 
 
33
<p>Tags <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> file containers with a DocumentID.  
 
34
 <a href="classOpenMS_1_1DocumentIDTagger.html#details">More...</a></p>
 
35
 
 
36
<p><code>#include &lt;<a class="el" href="DocumentIDTagger_8h_source.html">OpenMS/METADATA/DocumentIDTagger.h</a>&gt;</code></p>
 
37
<table class="memberdecls">
 
38
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 
39
Public Member Functions</h2></td></tr>
 
40
<tr class="memitem:a6baf8ed1574c57767e904d42acc2e641"><td class="memItemLeft" align="right" valign="top">&#160;</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>
 
41
<tr class="memdesc:a6baf8ed1574c57767e904d42acc2e641"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a6baf8ed1574c57767e904d42acc2e641">More...</a><br/></td></tr>
 
42
<tr class="separator:a6baf8ed1574c57767e904d42acc2e641"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
43
<tr class="memitem:ab4da81bf157b2d1f1b3a87e4e58999b5"><td class="memItemLeft" align="right" valign="top">&#160;</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> &amp;source)</td></tr>
 
44
<tr class="memdesc:ab4da81bf157b2d1f1b3a87e4e58999b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor.  <a href="#ab4da81bf157b2d1f1b3a87e4e58999b5">More...</a><br/></td></tr>
 
45
<tr class="separator:ab4da81bf157b2d1f1b3a87e4e58999b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
46
<tr class="memitem:ab4992186dec84998a7cd9ea6b27878c7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html#ab4992186dec84998a7cd9ea6b27878c7">~DocumentIDTagger</a> ()</td></tr>
 
47
<tr class="memdesc:ab4992186dec84998a7cd9ea6b27878c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#ab4992186dec84998a7cd9ea6b27878c7">More...</a><br/></td></tr>
 
48
<tr class="separator:ab4992186dec84998a7cd9ea6b27878c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
49
<tr class="memitem:a62bed24c0268915010c1b0d89ea82d3c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a> &amp;&#160;</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> &amp;source)</td></tr>
 
50
<tr class="memdesc:a62bed24c0268915010c1b0d89ea82d3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator.  <a href="#a62bed24c0268915010c1b0d89ea82d3c">More...</a><br/></td></tr>
 
51
<tr class="separator:a62bed24c0268915010c1b0d89ea82d3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
52
<tr class="memitem:a8a0a7dc275ff436efde201c3d2322eff"><td class="memItemLeft" align="right" valign="top">bool&#160;</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> &amp;source) const </td></tr>
 
53
<tr class="memdesc:a8a0a7dc275ff436efde201c3d2322eff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equality operator.  <a href="#a8a0a7dc275ff436efde201c3d2322eff">More...</a><br/></td></tr>
 
54
<tr class="separator:a8a0a7dc275ff436efde201c3d2322eff"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
55
<tr class="memitem:a41d9130262cc1b870b7dae7c9a04d535"><td class="memItemLeft" align="right" valign="top">bool&#160;</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> &amp;source) const </td></tr>
 
56
<tr class="memdesc:a41d9130262cc1b870b7dae7c9a04d535"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equality operator.  <a href="#a41d9130262cc1b870b7dae7c9a04d535">More...</a><br/></td></tr>
 
57
<tr class="separator:a41d9130262cc1b870b7dae7c9a04d535"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
58
<tr class="memitem:a700459da9be549759a0147e8049e2cb4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html#a700459da9be549759a0147e8049e2cb4">getPoolFile</a> () const </td></tr>
 
59
<tr class="memdesc:a700459da9be549759a0147e8049e2cb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the file used as ID pool.  <a href="#a700459da9be549759a0147e8049e2cb4">More...</a><br/></td></tr>
 
60
<tr class="separator:a700459da9be549759a0147e8049e2cb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
61
<tr class="memitem:a17f77efff59d80ffa4d1296a8e1b6eef"><td class="memItemLeft" align="right" valign="top">void&#160;</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> &amp;file)</td></tr>
 
62
<tr class="memdesc:a17f77efff59d80ffa4d1296a8e1b6eef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the file used as ID pool.  <a href="#a17f77efff59d80ffa4d1296a8e1b6eef">More...</a><br/></td></tr>
 
63
<tr class="separator:a17f77efff59d80ffa4d1296a8e1b6eef"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
64
<tr class="memitem:a26dcd47cc5aeecd27330b7813b6056b2"><td class="memItemLeft" align="right" valign="top">bool&#160;</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> &amp;map) const </td></tr>
 
65
<tr class="memdesc:a26dcd47cc5aeecd27330b7813b6056b2"><td class="mdescLeft">&#160;</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>
 
66
<tr class="separator:a26dcd47cc5aeecd27330b7813b6056b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
67
<tr class="memitem:aa5645b19947f67e4a944d4299d2196f6"><td class="memItemLeft" align="right" valign="top">bool&#160;</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> &amp;free) const </td></tr>
 
68
<tr class="memdesc:aa5645b19947f67e4a944d4299d2196f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">return the number of available IDs in the pool.  <a href="#aa5645b19947f67e4a944d4299d2196f6">More...</a><br/></td></tr>
 
69
<tr class="separator:aa5645b19947f67e4a944d4299d2196f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
70
</table><table class="memberdecls">
 
71
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
 
72
Protected Attributes</h2></td></tr>
 
73
<tr class="memitem:a4fb4db0bd3d688c678693d825fe0147f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html#a4fb4db0bd3d688c678693d825fe0147f">toolname_</a></td></tr>
 
74
<tr class="memdesc:a4fb4db0bd3d688c678693d825fe0147f"><td class="mdescLeft">&#160;</td><td class="mdescRight">name of the calling TOPP tool  <a href="#a4fb4db0bd3d688c678693d825fe0147f">More...</a><br/></td></tr>
 
75
<tr class="separator:a4fb4db0bd3d688c678693d825fe0147f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
76
<tr class="memitem:a10cf1f48bfc918d728b4d15ee95165a0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1String.html">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html#a10cf1f48bfc918d728b4d15ee95165a0">pool_file_</a></td></tr>
 
77
<tr class="memdesc:a10cf1f48bfc918d728b4d15ee95165a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">location of the ID pool  <a href="#a10cf1f48bfc918d728b4d15ee95165a0">More...</a><br/></td></tr>
 
78
<tr class="separator:a10cf1f48bfc918d728b4d15ee95165a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
79
</table><table class="memberdecls">
 
80
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
 
81
Private Member Functions</h2></td></tr>
 
82
<tr class="memitem:a0f26016a2e53abdf49c958c8e5f13178"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html#a0f26016a2e53abdf49c958c8e5f13178">DocumentIDTagger</a> ()</td></tr>
 
83
<tr class="memdesc:a0f26016a2e53abdf49c958c8e5f13178"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor (declared away)  <a href="#a0f26016a2e53abdf49c958c8e5f13178">More...</a><br/></td></tr>
 
84
<tr class="separator:a0f26016a2e53abdf49c958c8e5f13178"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
85
<tr class="memitem:a2a5facda334ec0e5bd2c3dc677c8d758"><td class="memItemLeft" align="right" valign="top">bool&#160;</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> &amp;id, <a class="el" href="group__Concept.html#ga7cc214a236ad3bb6ad435bdcf5262a3f">Int</a> &amp;free, bool idcount_only) const </td></tr>
 
86
<tr class="memdesc:a2a5facda334ec0e5bd2c3dc677c8d758"><td class="mdescLeft">&#160;</td><td class="mdescRight">retrieve an ID from the pool  <a href="#a2a5facda334ec0e5bd2c3dc677c8d758">More...</a><br/></td></tr>
 
87
<tr class="separator:a2a5facda334ec0e5bd2c3dc677c8d758"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
88
</table>
 
89
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 
90
<div class="textblock"><p>Tags <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> file containers with a DocumentID. </p>
 
91
<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>
 
92
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 
93
<a class="anchor" id="a0f26016a2e53abdf49c958c8e5f13178"></a>
 
94
<div class="memitem">
 
95
<div class="memproto">
 
96
<table class="mlabels">
 
97
  <tr>
 
98
  <td class="mlabels-left">
 
99
      <table class="memname">
 
100
        <tr>
 
101
          <td class="memname"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a> </td>
 
102
          <td>(</td>
 
103
          <td class="paramname"></td><td>)</td>
 
104
          <td></td>
 
105
        </tr>
 
106
      </table>
 
107
  </td>
 
108
  <td class="mlabels-right">
 
109
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
 
110
  </tr>
 
111
</table>
 
112
</div><div class="memdoc">
 
113
 
 
114
<p>Constructor (declared away) </p>
 
115
 
 
116
</div>
 
117
</div>
 
118
<a class="anchor" id="a6baf8ed1574c57767e904d42acc2e641"></a>
 
119
<div class="memitem">
 
120
<div class="memproto">
 
121
      <table class="memname">
 
122
        <tr>
 
123
          <td class="memname"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a> </td>
 
124
          <td>(</td>
 
125
          <td class="paramtype"><a class="el" href="classOpenMS_1_1String.html">String</a>&#160;</td>
 
126
          <td class="paramname"><em>toolname</em></td><td>)</td>
 
127
          <td></td>
 
128
        </tr>
 
129
      </table>
 
130
</div><div class="memdoc">
 
131
 
 
132
<p>Constructor. </p>
 
133
 
 
134
</div>
 
135
</div>
 
136
<a class="anchor" id="ab4da81bf157b2d1f1b3a87e4e58999b5"></a>
 
137
<div class="memitem">
 
138
<div class="memproto">
 
139
      <table class="memname">
 
140
        <tr>
 
141
          <td class="memname"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a> </td>
 
142
          <td>(</td>
 
143
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a> &amp;&#160;</td>
 
144
          <td class="paramname"><em>source</em></td><td>)</td>
 
145
          <td></td>
 
146
        </tr>
 
147
      </table>
 
148
</div><div class="memdoc">
 
149
 
 
150
<p>Copy constructor. </p>
 
151
 
 
152
</div>
 
153
</div>
 
154
<a class="anchor" id="ab4992186dec84998a7cd9ea6b27878c7"></a>
 
155
<div class="memitem">
 
156
<div class="memproto">
 
157
      <table class="memname">
 
158
        <tr>
 
159
          <td class="memname">~<a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a> </td>
 
160
          <td>(</td>
 
161
          <td class="paramname"></td><td>)</td>
 
162
          <td></td>
 
163
        </tr>
 
164
      </table>
 
165
</div><div class="memdoc">
 
166
 
 
167
<p>Destructor. </p>
 
168
 
 
169
</div>
 
170
</div>
 
171
<h2 class="groupheader">Member Function Documentation</h2>
 
172
<a class="anchor" id="aa5645b19947f67e4a944d4299d2196f6"></a>
 
173
<div class="memitem">
 
174
<div class="memproto">
 
175
      <table class="memname">
 
176
        <tr>
 
177
          <td class="memname">bool countFreeIDs </td>
 
178
          <td>(</td>
 
179
          <td class="paramtype"><a class="el" href="group__Concept.html#ga7cc214a236ad3bb6ad435bdcf5262a3f">Int</a> &amp;&#160;</td>
 
180
          <td class="paramname"><em>free</em></td><td>)</td>
 
181
          <td> const</td>
 
182
        </tr>
 
183
      </table>
 
184
</div><div class="memdoc">
 
185
 
 
186
<p>return the number of available IDs in the pool. </p>
 
187
<p>Retrieve the number of available IDs in the pool. Returns true of count was successful, false otherwise (locking error, file creation error ...)</p>
 
188
<dl class="params"><dt>Parameters</dt><dd>
 
189
  <table class="params">
 
190
    <tr><td class="paramname">free</td><td>Number of available identifiers. You should worry if it's 0! </td></tr>
 
191
  </table>
 
192
  </dd>
 
193
</dl>
 
194
 
 
195
</div>
 
196
</div>
 
197
<a class="anchor" id="a2a5facda334ec0e5bd2c3dc677c8d758"></a>
 
198
<div class="memitem">
 
199
<div class="memproto">
 
200
<table class="mlabels">
 
201
  <tr>
 
202
  <td class="mlabels-left">
 
203
      <table class="memname">
 
204
        <tr>
 
205
          <td class="memname">bool getID_ </td>
 
206
          <td>(</td>
 
207
          <td class="paramtype"><a class="el" href="classOpenMS_1_1String.html">String</a> &amp;&#160;</td>
 
208
          <td class="paramname"><em>id</em>, </td>
 
209
        </tr>
 
210
        <tr>
 
211
          <td class="paramkey"></td>
 
212
          <td></td>
 
213
          <td class="paramtype"><a class="el" href="group__Concept.html#ga7cc214a236ad3bb6ad435bdcf5262a3f">Int</a> &amp;&#160;</td>
 
214
          <td class="paramname"><em>free</em>, </td>
 
215
        </tr>
 
216
        <tr>
 
217
          <td class="paramkey"></td>
 
218
          <td></td>
 
219
          <td class="paramtype">bool&#160;</td>
 
220
          <td class="paramname"><em>idcount_only</em>&#160;</td>
 
221
        </tr>
 
222
        <tr>
 
223
          <td></td>
 
224
          <td>)</td>
 
225
          <td></td><td> const</td>
 
226
        </tr>
 
227
      </table>
 
228
  </td>
 
229
  <td class="mlabels-right">
 
230
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
 
231
  </tr>
 
232
</table>
 
233
</div><div class="memdoc">
 
234
 
 
235
<p>retrieve an ID from the pool </p>
 
236
<p>Uses boost filelocks to safely retrieve an ID from an ID pool.</p>
 
237
<dl class="params"><dt>Parameters</dt><dd>
 
238
  <table class="params">
 
239
    <tr><td class="paramname">id</td><td>Unique identifier returned from ID pool </td></tr>
 
240
    <tr><td class="paramname">free</td><td>Number of available identifiers in ID pool (before this query) </td></tr>
 
241
    <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>
 
242
  </table>
 
243
  </dd>
 
244
</dl>
 
245
<p>Return true if all file operations could be executed successfully (this does not imply there was an ID left over - check free&gt;0) </p>
 
246
 
 
247
</div>
 
248
</div>
 
249
<a class="anchor" id="a700459da9be549759a0147e8049e2cb4"></a>
 
250
<div class="memitem">
 
251
<div class="memproto">
 
252
      <table class="memname">
 
253
        <tr>
 
254
          <td class="memname"><a class="el" href="classOpenMS_1_1String.html">String</a> getPoolFile </td>
 
255
          <td>(</td>
 
256
          <td class="paramname"></td><td>)</td>
 
257
          <td> const</td>
 
258
        </tr>
 
259
      </table>
 
260
</div><div class="memdoc">
 
261
 
 
262
<p>Return the file used as ID pool. </p>
 
263
<p>The default ID pool file is in /share/OpenMS/IDPool/IDPool.txt A custom file can be set by setIDPoolFile() </p>
 
264
 
 
265
</div>
 
266
</div>
 
267
<a class="anchor" id="a41d9130262cc1b870b7dae7c9a04d535"></a>
 
268
<div class="memitem">
 
269
<div class="memproto">
 
270
      <table class="memname">
 
271
        <tr>
 
272
          <td class="memname">bool operator!= </td>
 
273
          <td>(</td>
 
274
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a> &amp;&#160;</td>
 
275
          <td class="paramname"><em>source</em></td><td>)</td>
 
276
          <td> const</td>
 
277
        </tr>
 
278
      </table>
 
279
</div><div class="memdoc">
 
280
 
 
281
<p>Equality operator. </p>
 
282
 
 
283
</div>
 
284
</div>
 
285
<a class="anchor" id="a62bed24c0268915010c1b0d89ea82d3c"></a>
 
286
<div class="memitem">
 
287
<div class="memproto">
 
288
      <table class="memname">
 
289
        <tr>
 
290
          <td class="memname"><a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a>&amp; operator= </td>
 
291
          <td>(</td>
 
292
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a> &amp;&#160;</td>
 
293
          <td class="paramname"><em>source</em></td><td>)</td>
 
294
          <td></td>
 
295
        </tr>
 
296
      </table>
 
297
</div><div class="memdoc">
 
298
 
 
299
<p>Assignment operator. </p>
 
300
 
 
301
</div>
 
302
</div>
 
303
<a class="anchor" id="a8a0a7dc275ff436efde201c3d2322eff"></a>
 
304
<div class="memitem">
 
305
<div class="memproto">
 
306
      <table class="memname">
 
307
        <tr>
 
308
          <td class="memname">bool operator== </td>
 
309
          <td>(</td>
 
310
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1DocumentIDTagger.html">DocumentIDTagger</a> &amp;&#160;</td>
 
311
          <td class="paramname"><em>source</em></td><td>)</td>
 
312
          <td> const</td>
 
313
        </tr>
 
314
      </table>
 
315
</div><div class="memdoc">
 
316
 
 
317
<p>Equality operator. </p>
 
318
 
 
319
</div>
 
320
</div>
 
321
<a class="anchor" id="a17f77efff59d80ffa4d1296a8e1b6eef"></a>
 
322
<div class="memitem">
 
323
<div class="memproto">
 
324
      <table class="memname">
 
325
        <tr>
 
326
          <td class="memname">void setPoolFile </td>
 
327
          <td>(</td>
 
328
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> &amp;&#160;</td>
 
329
          <td class="paramname"><em>file</em></td><td>)</td>
 
330
          <td></td>
 
331
        </tr>
 
332
      </table>
 
333
</div><div class="memdoc">
 
334
 
 
335
<p>Set the file used as ID pool. </p>
 
336
 
 
337
</div>
 
338
</div>
 
339
<a class="anchor" id="a26dcd47cc5aeecd27330b7813b6056b2"></a>
 
340
<div class="memitem">
 
341
<div class="memproto">
 
342
      <table class="memname">
 
343
        <tr>
 
344
          <td class="memname">bool tag </td>
 
345
          <td>(</td>
 
346
          <td class="paramtype"><a class="el" href="classOpenMS_1_1DocumentIdentifier.html">DocumentIdentifier</a> &amp;&#160;</td>
 
347
          <td class="paramname"><em>map</em></td><td>)</td>
 
348
          <td> const</td>
 
349
        </tr>
 
350
      </table>
 
351
</div><div class="memdoc">
 
352
 
 
353
<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>
 
354
<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&#39;s can be drawn from ID pool. ">Exception::DepletedIDPool</a> is thrown</p>
 
355
<dl class="params"><dt>Parameters</dt><dd>
 
356
  <table class="params">
 
357
    <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>
 
358
  </table>
 
359
  </dd>
 
360
</dl>
 
361
<dl class="exception"><dt>Exceptions</dt><dd>
 
362
  <table class="exception">
 
363
    <tr><td class="paramname"><a class="el" href="classOpenMS_1_1Exception_1_1DepletedIDPool.html" title="Exception used if no more unique document ID&#39;s can be drawn from ID pool. ">Exception::DepletedIDPool</a></td><td>when no identifier (for whatever reason) could be aquired </td></tr>
 
364
  </table>
 
365
  </dd>
 
366
</dl>
 
367
 
 
368
</div>
 
369
</div>
 
370
<h2 class="groupheader">Member Data Documentation</h2>
 
371
<a class="anchor" id="a10cf1f48bfc918d728b4d15ee95165a0"></a>
 
372
<div class="memitem">
 
373
<div class="memproto">
 
374
<table class="mlabels">
 
375
  <tr>
 
376
  <td class="mlabels-left">
 
377
      <table class="memname">
 
378
        <tr>
 
379
          <td class="memname"><a class="el" href="classOpenMS_1_1String.html">String</a> pool_file_</td>
 
380
        </tr>
 
381
      </table>
 
382
  </td>
 
383
  <td class="mlabels-right">
 
384
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 
385
  </tr>
 
386
</table>
 
387
</div><div class="memdoc">
 
388
 
 
389
<p>location of the ID pool </p>
 
390
 
 
391
</div>
 
392
</div>
 
393
<a class="anchor" id="a4fb4db0bd3d688c678693d825fe0147f"></a>
 
394
<div class="memitem">
 
395
<div class="memproto">
 
396
<table class="mlabels">
 
397
  <tr>
 
398
  <td class="mlabels-left">
 
399
      <table class="memname">
 
400
        <tr>
 
401
          <td class="memname"><a class="el" href="classOpenMS_1_1String.html">String</a> toolname_</td>
 
402
        </tr>
 
403
      </table>
 
404
  </td>
 
405
  <td class="mlabels-right">
 
406
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 
407
  </tr>
 
408
</table>
 
409
</div><div class="memdoc">
 
410
 
 
411
<p>name of the calling TOPP tool </p>
 
412
 
 
413
</div>
 
414
</div>
 
415
</div><!-- contents -->
 
416
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
417
<TABLE width="100%" border="0">
 
418
<TR>
 
419
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
 
420
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:32 using doxygen 1.8.5</font></TD>
 
421
</TR>
 
422
</TABLE>
 
423
</BODY>
 
424
</HTML>