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
|
<HTML>
<HEAD>
<TITLE>TOPPASResources 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_1TOPPASResources.html">TOPPASResources</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="classOpenMS_1_1TOPPASResources-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">TOPPASResources Class Reference<div class="ingroups"><a class="el" href="group__TOPPAS__elements.html">TOPPAS</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>A dictionary mapping string keys to lists of <a class="el" href="classOpenMS_1_1TOPPASResource.html" title="Represents a data resource for TOPPAS workflows. ">TOPPASResource</a> objects.
<a href="classOpenMS_1_1TOPPASResources.html#details">More...</a></p>
<p><code>#include <<a class="el" href="TOPPASResources_8h_source.html">OpenMS/VISUAL/TOPPASResources.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for TOPPASResources:</div>
<div class="dyncontent">
<div class="center">
<img src="classOpenMS_1_1TOPPASResources.png" usemap="#TOPPASResources_map" alt=""/>
<map id="TOPPASResources_map" name="TOPPASResources_map">
<area href="classQObject.html" alt="QObject" shape="rect" coords="0,0,122,24"/>
</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 class="memitem:aabe69143cf0d84daf0aeb0eaebc76ca5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResources.html#aabe69143cf0d84daf0aeb0eaebc76ca5">TOPPASResources</a> ()</td></tr>
<tr class="memdesc:aabe69143cf0d84daf0aeb0eaebc76ca5"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#aabe69143cf0d84daf0aeb0eaebc76ca5">More...</a><br/></td></tr>
<tr class="separator:aabe69143cf0d84daf0aeb0eaebc76ca5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6bee03656f4777c678e0cddbd7803e70"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResources.html#a6bee03656f4777c678e0cddbd7803e70">TOPPASResources</a> (const <a class="el" href="classOpenMS_1_1TOPPASResources.html">TOPPASResources</a> &rhs)</td></tr>
<tr class="memdesc:a6bee03656f4777c678e0cddbd7803e70"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#a6bee03656f4777c678e0cddbd7803e70">More...</a><br/></td></tr>
<tr class="separator:a6bee03656f4777c678e0cddbd7803e70"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5cb3f683ddc303397ae67d68ff65ae3"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResources.html#aa5cb3f683ddc303397ae67d68ff65ae3">~TOPPASResources</a> ()</td></tr>
<tr class="memdesc:aa5cb3f683ddc303397ae67d68ff65ae3"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#aa5cb3f683ddc303397ae67d68ff65ae3">More...</a><br/></td></tr>
<tr class="separator:aa5cb3f683ddc303397ae67d68ff65ae3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c7148ef054f974fe7d89c52173202f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1TOPPASResources.html">TOPPASResources</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResources.html#a0c7148ef054f974fe7d89c52173202f6">operator=</a> (const <a class="el" href="classOpenMS_1_1TOPPASResources.html">TOPPASResources</a> &rhs)</td></tr>
<tr class="memdesc:a0c7148ef054f974fe7d89c52173202f6"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#a0c7148ef054f974fe7d89c52173202f6">More...</a><br/></td></tr>
<tr class="separator:a0c7148ef054f974fe7d89c52173202f6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a83981a0888052447fb0fe6cbbd40fd7e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResources.html#a83981a0888052447fb0fe6cbbd40fd7e">add</a> (const QString &key, const QList< <a class="el" href="classOpenMS_1_1TOPPASResource.html">TOPPASResource</a> > &resource_list)</td></tr>
<tr class="memdesc:a83981a0888052447fb0fe6cbbd40fd7e"><td class="mdescLeft"> </td><td class="mdescRight">Adds the (key,resource_list) pair to the dictionary. <a href="#a83981a0888052447fb0fe6cbbd40fd7e">More...</a><br/></td></tr>
<tr class="separator:a83981a0888052447fb0fe6cbbd40fd7e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4476864975296e030aed9e4b28447636"><td class="memItemLeft" align="right" valign="top">const QList< <a class="el" href="classOpenMS_1_1TOPPASResource.html">TOPPASResource</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResources.html#a4476864975296e030aed9e4b28447636">get</a> (const QString &key) const </td></tr>
<tr class="memdesc:a4476864975296e030aed9e4b28447636"><td class="mdescLeft"> </td><td class="mdescRight">Returns the resource list that <code>key</code> is mapped to, or an empty list if <code>key</code> does not exist. <a href="#a4476864975296e030aed9e4b28447636">More...</a><br/></td></tr>
<tr class="separator:a4476864975296e030aed9e4b28447636"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a83a3660ffab2523b6e05e589c51d84a6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResources.html#a83a3660ffab2523b6e05e589c51d84a6">load</a> (const QString &file_name)</td></tr>
<tr class="memdesc:a83a3660ffab2523b6e05e589c51d84a6"><td class="mdescLeft"> </td><td class="mdescRight">Loads the dictionary from file <code>file_name</code>. <a href="#a83a3660ffab2523b6e05e589c51d84a6">More...</a><br/></td></tr>
<tr class="separator:a83a3660ffab2523b6e05e589c51d84a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9005bda017a2220dfb8ae0747865552"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResources.html#ae9005bda017a2220dfb8ae0747865552">store</a> (const QString &file_name)</td></tr>
<tr class="memdesc:ae9005bda017a2220dfb8ae0747865552"><td class="mdescLeft"> </td><td class="mdescRight">Writes the dictionary to file <code>file_name</code>. <a href="#ae9005bda017a2220dfb8ae0747865552">More...</a><br/></td></tr>
<tr class="separator:ae9005bda017a2220dfb8ae0747865552"><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_1TOPPASResources.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr>
<tr class="memdesc:ac8bb3912a3ce86b15842e79d0b421204"><td class="mdescLeft"> </td><td class="mdescRight">Clears the dictionary. <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="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a4d5c54177c4872fdfd0afd2e4db8e239"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1Map.html">Map</a>< QString, QList<br class="typebreak"/>
< <a class="el" href="classOpenMS_1_1TOPPASResource.html">TOPPASResource</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResources.html#a4d5c54177c4872fdfd0afd2e4db8e239">map_</a></td></tr>
<tr class="memdesc:a4d5c54177c4872fdfd0afd2e4db8e239"><td class="mdescLeft"> </td><td class="mdescRight">The dictionary. <a href="#a4d5c54177c4872fdfd0afd2e4db8e239">More...</a><br/></td></tr>
<tr class="separator:a4d5c54177c4872fdfd0afd2e4db8e239"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa520380a0938f593345a78c949fb4070"><td class="memItemLeft" align="right" valign="top">QList< <a class="el" href="classOpenMS_1_1TOPPASResource.html">TOPPASResource</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResources.html#aa520380a0938f593345a78c949fb4070">empty_list_</a></td></tr>
<tr class="memdesc:aa520380a0938f593345a78c949fb4070"><td class="mdescLeft"> </td><td class="mdescRight">The empty list. <a href="#aa520380a0938f593345a78c949fb4070">More...</a><br/></td></tr>
<tr class="separator:aa520380a0938f593345a78c949fb4070"><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 dictionary mapping string keys to lists of <a class="el" href="classOpenMS_1_1TOPPASResource.html" title="Represents a data resource for TOPPAS workflows. ">TOPPASResource</a> objects. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="aabe69143cf0d84daf0aeb0eaebc76ca5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1TOPPASResources.html">TOPPASResources</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="a6bee03656f4777c678e0cddbd7803e70"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1TOPPASResources.html">TOPPASResources</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1TOPPASResources.html">TOPPASResources</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="aa5cb3f683ddc303397ae67d68ff65ae3"></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_1TOPPASResources.html">TOPPASResources</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>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a83981a0888052447fb0fe6cbbd40fd7e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void add </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QList< <a class="el" href="classOpenMS_1_1TOPPASResource.html">TOPPASResource</a> > & </td>
<td class="paramname"><em>resource_list</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds the (key,resource_list) pair to the dictionary. </p>
</div>
</div>
<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>Clears the dictionary. </p>
</div>
</div>
<a class="anchor" id="a4476864975296e030aed9e4b28447636"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const QList<<a class="el" href="classOpenMS_1_1TOPPASResource.html">TOPPASResource</a>>& get </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the resource list that <code>key</code> is mapped to, or an empty list if <code>key</code> does not exist. </p>
</div>
</div>
<a class="anchor" id="a83a3660ffab2523b6e05e589c51d84a6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void load </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>file_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads the dictionary from file <code>file_name</code>. </p>
<p>Referenced by <a class="el" href="classOpenMS_1_1TOPPASBase.html#a234041073ed00171a96d7d4d0df7471c">TOPPASBase::loadPipelineResourceFile()</a>.</p>
</div>
</div>
<a class="anchor" id="a0c7148ef054f974fe7d89c52173202f6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1TOPPASResources.html">TOPPASResources</a>& operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1TOPPASResources.html">TOPPASResources</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="ae9005bda017a2220dfb8ae0747865552"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void store </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>file_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes the dictionary to file <code>file_name</code>. </p>
<p>Referenced by <a class="el" href="classOpenMS_1_1TOPPASBase.html#ad65396dd7691d9de528d5bfc3b6707be">TOPPASBase::savePipelineResourceFile()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aa520380a0938f593345a78c949fb4070"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QList<<a class="el" href="classOpenMS_1_1TOPPASResource.html">TOPPASResource</a>> empty_list_</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>The empty list. </p>
</div>
</div>
<a class="anchor" id="a4d5c54177c4872fdfd0afd2e4db8e239"></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_1Map.html">Map</a><QString, QList<<a class="el" href="classOpenMS_1_1TOPPASResource.html">TOPPASResource</a>> > map_</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>The dictionary. </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:36 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
