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
|
<HTML>
<HEAD>
<TITLE>TOPPASResource 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_1TOPPASResource.html">TOPPASResource</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classOpenMS_1_1TOPPASResource-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">TOPPASResource Class Reference<div class="ingroups"><a class="el" href="group__TOPPAS__elements.html">TOPPAS</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Represents a data resource for TOPPAS workflows.
<a href="classOpenMS_1_1TOPPASResource.html#details">More...</a></p>
<p><code>#include <<a class="el" href="TOPPASResource_8h_source.html">OpenMS/VISUAL/TOPPASResource.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for TOPPASResource:</div>
<div class="dyncontent">
<div class="center">
<img src="classOpenMS_1_1TOPPASResource.png" usemap="#TOPPASResource_map" alt=""/>
<map id="TOPPASResource_map" name="TOPPASResource_map">
<area href="classQObject.html" alt="QObject" shape="rect" coords="0,0,116,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:a5936a1d4961fb2a6e70b4cac59ae7d73"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResource.html#a5936a1d4961fb2a6e70b4cac59ae7d73">TOPPASResource</a> (const QString &file)</td></tr>
<tr class="memdesc:a5936a1d4961fb2a6e70b4cac59ae7d73"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a5936a1d4961fb2a6e70b4cac59ae7d73">More...</a><br/></td></tr>
<tr class="separator:a5936a1d4961fb2a6e70b4cac59ae7d73"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a274f7f94b456bd742ad823c845c460c3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResource.html#a274f7f94b456bd742ad823c845c460c3">TOPPASResource</a> (const QUrl &url)</td></tr>
<tr class="memdesc:a274f7f94b456bd742ad823c845c460c3"><td class="mdescLeft"> </td><td class="mdescRight">Constructor from URL. <a href="#a274f7f94b456bd742ad823c845c460c3">More...</a><br/></td></tr>
<tr class="separator:a274f7f94b456bd742ad823c845c460c3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adf459693bea3e39f9adcffa2136fdf3c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResource.html#adf459693bea3e39f9adcffa2136fdf3c">TOPPASResource</a> (const <a class="el" href="classOpenMS_1_1TOPPASResource.html">TOPPASResource</a> &rhs)</td></tr>
<tr class="memdesc:adf459693bea3e39f9adcffa2136fdf3c"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#adf459693bea3e39f9adcffa2136fdf3c">More...</a><br/></td></tr>
<tr class="separator:adf459693bea3e39f9adcffa2136fdf3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39c7ae4af6f5169fd8b4bdfde7b19eef"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResource.html#a39c7ae4af6f5169fd8b4bdfde7b19eef">~TOPPASResource</a> ()</td></tr>
<tr class="memdesc:a39c7ae4af6f5169fd8b4bdfde7b19eef"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a39c7ae4af6f5169fd8b4bdfde7b19eef">More...</a><br/></td></tr>
<tr class="separator:a39c7ae4af6f5169fd8b4bdfde7b19eef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab14099348862cc2d3a967db27214ab23"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1TOPPASResource.html">TOPPASResource</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResource.html#ab14099348862cc2d3a967db27214ab23">operator=</a> (const <a class="el" href="classOpenMS_1_1TOPPASResource.html">TOPPASResource</a> &rhs)</td></tr>
<tr class="memdesc:ab14099348862cc2d3a967db27214ab23"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#ab14099348862cc2d3a967db27214ab23">More...</a><br/></td></tr>
<tr class="separator:ab14099348862cc2d3a967db27214ab23"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8bb4ea03253702088d22b9a739b5ff05"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResource.html#a8bb4ea03253702088d22b9a739b5ff05">writeToFile</a> (const QString &file_name)</td></tr>
<tr class="memdesc:a8bb4ea03253702088d22b9a739b5ff05"><td class="mdescLeft"> </td><td class="mdescRight">Writes this resource to the local file <code>file</code>. <a href="#a8bb4ea03253702088d22b9a739b5ff05">More...</a><br/></td></tr>
<tr class="separator:a8bb4ea03253702088d22b9a739b5ff05"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7029b5ca827cdf293deeadf151941027"><td class="memItemLeft" align="right" valign="top">const QString & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResource.html#a7029b5ca827cdf293deeadf151941027">getLocalFile</a> () const </td></tr>
<tr class="memdesc:a7029b5ca827cdf293deeadf151941027"><td class="mdescLeft"> </td><td class="mdescRight">Returns the file name of the local file, or "" if it has not been written yet. <a href="#a7029b5ca827cdf293deeadf151941027">More...</a><br/></td></tr>
<tr class="separator:a7029b5ca827cdf293deeadf151941027"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a29ba7d6a6a1bd0ed258b45417ecdfb16"><td class="memItemLeft" align="right" valign="top">const QUrl & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResource.html#a29ba7d6a6a1bd0ed258b45417ecdfb16">getURL</a> () const </td></tr>
<tr class="memdesc:a29ba7d6a6a1bd0ed258b45417ecdfb16"><td class="mdescLeft"> </td><td class="mdescRight">Returns the URL of this resource. <a href="#a29ba7d6a6a1bd0ed258b45417ecdfb16">More...</a><br/></td></tr>
<tr class="separator:a29ba7d6a6a1bd0ed258b45417ecdfb16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a95a6bb0f1f8641879fc482eef43b9bfa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResource.html#a95a6bb0f1f8641879fc482eef43b9bfa">fromLocalFile</a> (const QString &file)</td></tr>
<tr class="memdesc:a95a6bb0f1f8641879fc482eef43b9bfa"><td class="mdescLeft"> </td><td class="mdescRight">Sets the URL of this resource from <code>file</code>. <a href="#a95a6bb0f1f8641879fc482eef43b9bfa">More...</a><br/></td></tr>
<tr class="separator:a95a6bb0f1f8641879fc482eef43b9bfa"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a46bb08ac05faf71887f5cb412f4263b0"><td class="memItemLeft" align="right" valign="top">static QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResource.html#a46bb08ac05faf71887f5cb412f4263b0">supported_schemes</a></td></tr>
<tr class="memdesc:a46bb08ac05faf71887f5cb412f4263b0"><td class="mdescLeft"> </td><td class="mdescRight">Supported schemes. <a href="#a46bb08ac05faf71887f5cb412f4263b0">More...</a><br/></td></tr>
<tr class="separator:a46bb08ac05faf71887f5cb412f4263b0"><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:abbbc145c7bfb61038815e9960fd5c4f5"><td class="memItemLeft" align="right" valign="top">QUrl </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResource.html#abbbc145c7bfb61038815e9960fd5c4f5">url_</a></td></tr>
<tr class="memdesc:abbbc145c7bfb61038815e9960fd5c4f5"><td class="mdescLeft"> </td><td class="mdescRight">The URL of this resource. <a href="#abbbc145c7bfb61038815e9960fd5c4f5">More...</a><br/></td></tr>
<tr class="separator:abbbc145c7bfb61038815e9960fd5c4f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6eb6164f29e08913d0af05784f7b3bc6"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1TOPPASResource.html#a6eb6164f29e08913d0af05784f7b3bc6">file_name_</a></td></tr>
<tr class="memdesc:a6eb6164f29e08913d0af05784f7b3bc6"><td class="mdescLeft"> </td><td class="mdescRight">The name of the local file. <a href="#a6eb6164f29e08913d0af05784f7b3bc6">More...</a><br/></td></tr>
<tr class="separator:a6eb6164f29e08913d0af05784f7b3bc6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents a data resource for TOPPAS workflows. </p>
<p>Currently, the only supported type of resource is local files. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5936a1d4961fb2a6e70b4cac59ae7d73"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1TOPPASResource.html">TOPPASResource</a> </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>file</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<a class="anchor" id="a274f7f94b456bd742ad823c845c460c3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1TOPPASResource.html">TOPPASResource</a> </td>
<td>(</td>
<td class="paramtype">const QUrl & </td>
<td class="paramname"><em>url</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor from URL. </p>
</div>
</div>
<a class="anchor" id="adf459693bea3e39f9adcffa2136fdf3c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1TOPPASResource.html">TOPPASResource</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1TOPPASResource.html">TOPPASResource</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="a39c7ae4af6f5169fd8b4bdfde7b19eef"></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_1TOPPASResource.html">TOPPASResource</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="a95a6bb0f1f8641879fc482eef43b9bfa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fromLocalFile </td>
<td>(</td>
<td class="paramtype">const QString & </td>
<td class="paramname"><em>file</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the URL of this resource from <code>file</code>. </p>
</div>
</div>
<a class="anchor" id="a7029b5ca827cdf293deeadf151941027"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const QString& getLocalFile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the file name of the local file, or "" if it has not been written yet. </p>
</div>
</div>
<a class="anchor" id="a29ba7d6a6a1bd0ed258b45417ecdfb16"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const QUrl& getURL </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the URL of this resource. </p>
</div>
</div>
<a class="anchor" id="ab14099348862cc2d3a967db27214ab23"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1TOPPASResource.html">TOPPASResource</a>& operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1TOPPASResource.html">TOPPASResource</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="a8bb4ea03253702088d22b9a739b5ff05"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void writeToFile </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 this resource to the local file <code>file</code>. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a6eb6164f29e08913d0af05784f7b3bc6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QString file_name_</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 name of the local file. </p>
</div>
</div>
<a class="anchor" id="a46bb08ac05faf71887f5cb412f4263b0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QStringList supported_schemes</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>Supported schemes. </p>
</div>
</div>
<a class="anchor" id="abbbc145c7bfb61038815e9960fd5c4f5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QUrl url_</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 URL of this resource. </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>
|
