3
<TITLE>MS2File Class Reference</TITLE>
4
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
5
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
7
<BODY BGCOLOR="#FFFFFF">
8
<A href="index.html">Home</A> ·
9
<A href="classes.html">Classes</A> ·
10
<A href="annotated.html">Annotated Classes</A> ·
11
<A href="modules.html">Modules</A> ·
12
<A href="functions_func.html">Members</A> ·
13
<A href="namespaces.html">Namespaces</A> ·
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">
19
<li class="navelem"><a class="el" href="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="classOpenMS_1_1MS2File.html">MS2File</a></li> </ul>
24
<a href="#pub-methods">Public Member Functions</a> |
25
<a href="classOpenMS_1_1MS2File-members.html">List of all members</a> </div>
26
<div class="headertitle">
27
<div class="title">MS2File Class Reference<div class="ingroups"><a class="el" href="group__FileIO.html">File IO</a></div></div> </div>
29
<div class="contents">
31
<p>MS2 input file adapter.
32
<a href="classOpenMS_1_1MS2File.html#details">More...</a></p>
34
<p><code>#include <<a class="el" href="MS2File_8h_source.html">OpenMS/FORMAT/MS2File.h</a>></code></p>
35
<div class="dynheader">
36
Inheritance diagram for MS2File:</div>
37
<div class="dyncontent">
39
<img src="classOpenMS_1_1MS2File.png" usemap="#MS2File_map" alt=""/>
40
<map id="MS2File_map" name="MS2File_map">
41
<area href="classOpenMS_1_1ProgressLogger.html" title="Base class for all classes that want to report their progess. " alt="ProgressLogger" shape="rect" coords="0,0,103,24"/>
44
<table class="memberdecls">
45
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
46
Public Member Functions</h2></td></tr>
47
<tr class="memitem:a1c2b9bfed175faff9fff1b8f7b847fc4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MS2File.html#a1c2b9bfed175faff9fff1b8f7b847fc4">MS2File</a> ()</td></tr>
48
<tr class="memdesc:a1c2b9bfed175faff9fff1b8f7b847fc4"><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#a1c2b9bfed175faff9fff1b8f7b847fc4">More...</a><br/></td></tr>
49
<tr class="separator:a1c2b9bfed175faff9fff1b8f7b847fc4"><td class="memSeparator" colspan="2"> </td></tr>
50
<tr class="memitem:afce38ea59fb9864edc8d0703cbd6a223"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MS2File.html#afce38ea59fb9864edc8d0703cbd6a223">~MS2File</a> ()</td></tr>
51
<tr class="memdesc:afce38ea59fb9864edc8d0703cbd6a223"><td class="mdescLeft"> </td><td class="mdescRight">constructor <a href="#afce38ea59fb9864edc8d0703cbd6a223">More...</a><br/></td></tr>
52
<tr class="separator:afce38ea59fb9864edc8d0703cbd6a223"><td class="memSeparator" colspan="2"> </td></tr>
53
<tr class="memitem:a98bebe67b8b06a9a67a3654d631355b4"><td class="memTemplParams" colspan="2">template<typename MapType > </td></tr>
54
<tr class="memitem:a98bebe67b8b06a9a67a3654d631355b4"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MS2File.html#a98bebe67b8b06a9a67a3654d631355b4">load</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &filename, MapType &exp)</td></tr>
55
<tr class="separator:a98bebe67b8b06a9a67a3654d631355b4"><td class="memSeparator" colspan="2"> </td></tr>
56
<tr class="inherit_header pub_methods_classOpenMS_1_1ProgressLogger"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classOpenMS_1_1ProgressLogger')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classOpenMS_1_1ProgressLogger.html">ProgressLogger</a></td></tr>
57
<tr class="memitem:a2a106011aec95b2013d7a545f2063d01 inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a2a106011aec95b2013d7a545f2063d01">ProgressLogger</a> ()</td></tr>
58
<tr class="memdesc:a2a106011aec95b2013d7a545f2063d01 inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a2a106011aec95b2013d7a545f2063d01">More...</a><br/></td></tr>
59
<tr class="separator:a2a106011aec95b2013d7a545f2063d01 inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="memSeparator" colspan="2"> </td></tr>
60
<tr class="memitem:a19c882d907f90f7f88c7436d82cd2a13 inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a19c882d907f90f7f88c7436d82cd2a13">~ProgressLogger</a> ()</td></tr>
61
<tr class="memdesc:a19c882d907f90f7f88c7436d82cd2a13 inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a19c882d907f90f7f88c7436d82cd2a13">More...</a><br/></td></tr>
62
<tr class="separator:a19c882d907f90f7f88c7436d82cd2a13 inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="memSeparator" colspan="2"> </td></tr>
63
<tr class="memitem:acc3538c5284777d8702ccaefeb61e74c inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#acc3538c5284777d8702ccaefeb61e74c">setLogType</a> (<a class="el" href="classOpenMS_1_1ProgressLogger.html#af67907baa897e9fb84df0cb89795b87c">LogType</a> type) const </td></tr>
64
<tr class="memdesc:acc3538c5284777d8702ccaefeb61e74c inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="mdescLeft"> </td><td class="mdescRight">Sets the progress log that should be used. The default type is NONE! <a href="#acc3538c5284777d8702ccaefeb61e74c">More...</a><br/></td></tr>
65
<tr class="separator:acc3538c5284777d8702ccaefeb61e74c inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="memSeparator" colspan="2"> </td></tr>
66
<tr class="memitem:a67024cdd5c34ec571baecabd8f783310 inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1ProgressLogger.html#af67907baa897e9fb84df0cb89795b87c">LogType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a67024cdd5c34ec571baecabd8f783310">getLogType</a> () const </td></tr>
67
<tr class="memdesc:a67024cdd5c34ec571baecabd8f783310 inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="mdescLeft"> </td><td class="mdescRight">Returns the type of progress log being used. <a href="#a67024cdd5c34ec571baecabd8f783310">More...</a><br/></td></tr>
68
<tr class="separator:a67024cdd5c34ec571baecabd8f783310 inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="memSeparator" colspan="2"> </td></tr>
69
<tr class="memitem:af1c45ecd71b5041b70319249e8e73591 inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#af1c45ecd71b5041b70319249e8e73591">startProgress</a> (<a class="el" href="group__Concept.html#gae113cb41304c6692c7bf5d0624dc6f0f">SignedSize</a> begin, <a class="el" href="group__Concept.html#gae113cb41304c6692c7bf5d0624dc6f0f">SignedSize</a> end, const <a class="el" href="classOpenMS_1_1String.html">String</a> &label) const </td></tr>
70
<tr class="memdesc:af1c45ecd71b5041b70319249e8e73591 inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the progress display. <a href="#af1c45ecd71b5041b70319249e8e73591">More...</a><br/></td></tr>
71
<tr class="separator:af1c45ecd71b5041b70319249e8e73591 inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="memSeparator" colspan="2"> </td></tr>
72
<tr class="memitem:a8852277abd03220cc7b80d6c1bed6fed inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a8852277abd03220cc7b80d6c1bed6fed">setProgress</a> (<a class="el" href="group__Concept.html#gae113cb41304c6692c7bf5d0624dc6f0f">SignedSize</a> value) const </td></tr>
73
<tr class="memdesc:a8852277abd03220cc7b80d6c1bed6fed inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="mdescLeft"> </td><td class="mdescRight">Sets the current progress. <a href="#a8852277abd03220cc7b80d6c1bed6fed">More...</a><br/></td></tr>
74
<tr class="separator:a8852277abd03220cc7b80d6c1bed6fed inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="memSeparator" colspan="2"> </td></tr>
75
<tr class="memitem:a1cc1012b0cdaea97f58d571af1ff45de inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a1cc1012b0cdaea97f58d571af1ff45de">endProgress</a> () const </td></tr>
76
<tr class="memdesc:a1cc1012b0cdaea97f58d571af1ff45de inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="mdescLeft"> </td><td class="mdescRight">Ends the progress display. <a href="#a1cc1012b0cdaea97f58d571af1ff45de">More...</a><br/></td></tr>
77
<tr class="separator:a1cc1012b0cdaea97f58d571af1ff45de inherit pub_methods_classOpenMS_1_1ProgressLogger"><td class="memSeparator" colspan="2"> </td></tr>
78
</table><table class="memberdecls">
79
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
80
Additional Inherited Members</h2></td></tr>
81
<tr class="inherit_header pub_types_classOpenMS_1_1ProgressLogger"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classOpenMS_1_1ProgressLogger')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classOpenMS_1_1ProgressLogger.html">ProgressLogger</a></td></tr>
82
<tr class="memitem:af67907baa897e9fb84df0cb89795b87c inherit pub_types_classOpenMS_1_1ProgressLogger"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#af67907baa897e9fb84df0cb89795b87c">LogType</a> { <a class="el" href="classOpenMS_1_1ProgressLogger.html#af67907baa897e9fb84df0cb89795b87ca3ab34dd50405af2d5a62627d572f7860">CMD</a>,
83
<a class="el" href="classOpenMS_1_1ProgressLogger.html#af67907baa897e9fb84df0cb89795b87ca73c6901c7c648a6a735770bc038bb26a">GUI</a>,
84
<a class="el" href="classOpenMS_1_1ProgressLogger.html#af67907baa897e9fb84df0cb89795b87cac157bdf0b85a40d2619cbc8bc1ae5fe2">NONE</a>
86
<tr class="memdesc:af67907baa897e9fb84df0cb89795b87c"><td class="mdescLeft"> </td><td class="mdescRight">Possible log types. <a href="classOpenMS_1_1ProgressLogger.html#af67907baa897e9fb84df0cb89795b87c">More...</a><br/></td></tr>
87
<tr class="separator:af67907baa897e9fb84df0cb89795b87c inherit pub_types_classOpenMS_1_1ProgressLogger"><td class="memSeparator" colspan="2"> </td></tr>
88
<tr class="inherit_header pro_attribs_classOpenMS_1_1ProgressLogger"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classOpenMS_1_1ProgressLogger')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classOpenMS_1_1ProgressLogger.html">ProgressLogger</a></td></tr>
89
<tr class="memitem:a7c691d7de2a43bc5606e96cb15da3641 inherit pro_attribs_classOpenMS_1_1ProgressLogger"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1ProgressLogger.html#af67907baa897e9fb84df0cb89795b87c">LogType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a7c691d7de2a43bc5606e96cb15da3641">type_</a></td></tr>
90
<tr class="separator:a7c691d7de2a43bc5606e96cb15da3641 inherit pro_attribs_classOpenMS_1_1ProgressLogger"><td class="memSeparator" colspan="2"> </td></tr>
91
<tr class="memitem:a56589612e0e4164bf80c3918a087d05a inherit pro_attribs_classOpenMS_1_1ProgressLogger"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gae113cb41304c6692c7bf5d0624dc6f0f">SignedSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a56589612e0e4164bf80c3918a087d05a">begin_</a></td></tr>
92
<tr class="separator:a56589612e0e4164bf80c3918a087d05a inherit pro_attribs_classOpenMS_1_1ProgressLogger"><td class="memSeparator" colspan="2"> </td></tr>
93
<tr class="memitem:a0c749bf4e621699b7a5c45ae22c2fa90 inherit pro_attribs_classOpenMS_1_1ProgressLogger"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gae113cb41304c6692c7bf5d0624dc6f0f">SignedSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a0c749bf4e621699b7a5c45ae22c2fa90">end_</a></td></tr>
94
<tr class="separator:a0c749bf4e621699b7a5c45ae22c2fa90 inherit pro_attribs_classOpenMS_1_1ProgressLogger"><td class="memSeparator" colspan="2"> </td></tr>
95
<tr class="memitem:aec57b26e143202dc119a41592e075932 inherit pro_attribs_classOpenMS_1_1ProgressLogger"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gae113cb41304c6692c7bf5d0624dc6f0f">SignedSize</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#aec57b26e143202dc119a41592e075932">value_</a></td></tr>
96
<tr class="separator:aec57b26e143202dc119a41592e075932 inherit pro_attribs_classOpenMS_1_1ProgressLogger"><td class="memSeparator" colspan="2"> </td></tr>
97
<tr class="memitem:a76072b3919abcf01141ba68da8a001fd inherit pro_attribs_classOpenMS_1_1ProgressLogger"><td class="memItemLeft" align="right" valign="top">QProgressDialog * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a76072b3919abcf01141ba68da8a001fd">dlg_</a></td></tr>
98
<tr class="separator:a76072b3919abcf01141ba68da8a001fd inherit pro_attribs_classOpenMS_1_1ProgressLogger"><td class="memSeparator" colspan="2"> </td></tr>
99
<tr class="memitem:a6d9750520313ea7f843d7a49cb2e9e5f inherit pro_attribs_classOpenMS_1_1ProgressLogger"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1StopWatch.html">StopWatch</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a6d9750520313ea7f843d7a49cb2e9e5f">stop_watch_</a></td></tr>
100
<tr class="separator:a6d9750520313ea7f843d7a49cb2e9e5f inherit pro_attribs_classOpenMS_1_1ProgressLogger"><td class="memSeparator" colspan="2"> </td></tr>
101
<tr class="memitem:a79bacf60c4109d7517590441c7f85f9c inherit pro_attribs_classOpenMS_1_1ProgressLogger"><td class="memItemLeft" align="right" valign="top">time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a79bacf60c4109d7517590441c7f85f9c">last_invoke_</a></td></tr>
102
<tr class="separator:a79bacf60c4109d7517590441c7f85f9c inherit pro_attribs_classOpenMS_1_1ProgressLogger"><td class="memSeparator" colspan="2"> </td></tr>
103
<tr class="inherit_header pro_static_attribs_classOpenMS_1_1ProgressLogger"><td colspan="2" onclick="javascript:toggleInherit('pro_static_attribs_classOpenMS_1_1ProgressLogger')"><img src="closed.png" alt="-"/> Static Protected Attributes inherited from <a class="el" href="classOpenMS_1_1ProgressLogger.html">ProgressLogger</a></td></tr>
104
<tr class="memitem:a94eb3ef5ef94b83eb348dd00a2b53119 inherit pro_static_attribs_classOpenMS_1_1ProgressLogger"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProgressLogger.html#a94eb3ef5ef94b83eb348dd00a2b53119">recursion_depth_</a></td></tr>
105
<tr class="separator:a94eb3ef5ef94b83eb348dd00a2b53119 inherit pro_static_attribs_classOpenMS_1_1ProgressLogger"><td class="memSeparator" colspan="2"> </td></tr>
107
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
108
<div class="textblock"><p>MS2 input file adapter. </p>
109
<p>For the format description take a look at: Rapid Commun Mass Spectrom. 2004;18(18):2162-8.</p>
110
<p>MS1, MS2, and SQT-three unified, compact, and easily parsed file formats for the storage of shotgun proteomic spectra and identifications.</p>
111
<p>McDonald WH, Tabb DL, Sadygov RG, MacCoss MJ, Venable J, Graumann J, Johnson JR, Cociorva D, Yates JR 3rd.</p>
112
<p>PMID: 15317041 </p>
113
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
114
<a class="anchor" id="a1c2b9bfed175faff9fff1b8f7b847fc4"></a>
115
<div class="memitem">
116
<div class="memproto">
117
<table class="memname">
119
<td class="memname"><a class="el" href="classOpenMS_1_1MS2File.html">MS2File</a> </td>
121
<td class="paramname"></td><td>)</td>
125
</div><div class="memdoc">
131
<a class="anchor" id="afce38ea59fb9864edc8d0703cbd6a223"></a>
132
<div class="memitem">
133
<div class="memproto">
134
<table class="mlabels">
136
<td class="mlabels-left">
137
<table class="memname">
139
<td class="memname">virtual ~<a class="el" href="classOpenMS_1_1MS2File.html">MS2File</a> </td>
141
<td class="paramname"></td><td>)</td>
146
<td class="mlabels-right">
147
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
150
</div><div class="memdoc">
156
<h2 class="groupheader">Member Function Documentation</h2>
157
<a class="anchor" id="a98bebe67b8b06a9a67a3654d631355b4"></a>
158
<div class="memitem">
159
<div class="memproto">
160
<table class="mlabels">
162
<td class="mlabels-left">
163
<table class="memname">
165
<td class="memname">void load </td>
167
<td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> & </td>
168
<td class="paramname"><em>filename</em>, </td>
171
<td class="paramkey"></td>
173
<td class="paramtype">MapType & </td>
174
<td class="paramname"><em>exp</em> </td>
183
<td class="mlabels-right">
184
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
187
</div><div class="memdoc">
189
<p>References <a class="el" href="classOpenMS_1_1File.html#a103bc592f26fed81f56f2f92b7ab5063">File::exists()</a>, <a class="el" href="classOpenMS_1_1File.html#abd34aea245381ce44044c36ce1895470">File::readable()</a>, <a class="el" href="classOpenMS_1_1String.html#a23eb8a9a84f24127e87e0fb41076254c">String::simplify()</a>, <a class="el" href="classOpenMS_1_1String.html#ae580d960e12c7f0ebc5c95931cf39ad5">String::split()</a>, and <a class="el" href="classOpenMS_1_1String.html#a86864c88ee12eb322f1645f238c1dbe5">String::trim()</a>.</p>
191
<p>Referenced by <a class="el" href="classOpenMS_1_1FileHandler.html#a408091416e0e1f6019abd59bdb6a9269">FileHandler::loadExperiment()</a>.</p>
195
</div><!-- contents -->
196
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
197
<TABLE width="100%" border="0">
199
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
200
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:31 using doxygen 1.8.5</font></TD>