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
|
<HTML>
<HEAD>
<TITLE>OMSSACSVFile 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_1OMSSACSVFile.html">OMSSACSVFile</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classOpenMS_1_1OMSSACSVFile-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">OMSSACSVFile Class Reference<div class="ingroups"><a class="el" href="group__FileIO.html">File IO</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classOpenMS_1_1File.html" title="Basic file handling operations. ">File</a> adapter for OMSSACSV files.
<a href="classOpenMS_1_1OMSSACSVFile.html#details">More...</a></p>
<p><code>#include <<a class="el" href="OMSSACSVFile_8h_source.html">OpenMS/FORMAT/OMSSACSVFile.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:a194210946ebf723a715b74f2744e0500"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1OMSSACSVFile.html#a194210946ebf723a715b74f2744e0500">OMSSACSVFile</a> ()</td></tr>
<tr class="memdesc:a194210946ebf723a715b74f2744e0500"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a194210946ebf723a715b74f2744e0500">More...</a><br/></td></tr>
<tr class="separator:a194210946ebf723a715b74f2744e0500"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a630ea1492dda5c2ce28c382aba0aa4e2"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1OMSSACSVFile.html#a630ea1492dda5c2ce28c382aba0aa4e2">~OMSSACSVFile</a> ()</td></tr>
<tr class="memdesc:a630ea1492dda5c2ce28c382aba0aa4e2"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a630ea1492dda5c2ce28c382aba0aa4e2">More...</a><br/></td></tr>
<tr class="separator:a630ea1492dda5c2ce28c382aba0aa4e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac846774fdbf6b75119eace2e26049bfc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1OMSSACSVFile.html#ac846774fdbf6b75119eace2e26049bfc">load</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &filename, <a class="el" href="classOpenMS_1_1ProteinIdentification.html">ProteinIdentification</a> &protein_identification, std::vector< <a class="el" href="classOpenMS_1_1PeptideIdentification.html">PeptideIdentification</a> > &id_data) const </td></tr>
<tr class="memdesc:ac846774fdbf6b75119eace2e26049bfc"><td class="mdescLeft"> </td><td class="mdescRight">Loads a OMSSA file. <a href="#ac846774fdbf6b75119eace2e26049bfc">More...</a><br/></td></tr>
<tr class="separator:ac846774fdbf6b75119eace2e26049bfc"><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 class="el" href="classOpenMS_1_1File.html" title="Basic file handling operations. ">File</a> adapter for OMSSACSV files. </p>
<p>The files contain the results of the OMSSA algorithm in a comma separated manner. This file adapter is able to load the data from such a file into the structures of <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a194210946ebf723a715b74f2744e0500"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1OMSSACSVFile.html">OMSSACSVFile</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>
</div>
</div>
<a class="anchor" id="a630ea1492dda5c2ce28c382aba0aa4e2"></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_1OMSSACSVFile.html">OMSSACSVFile</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="ac846774fdbf6b75119eace2e26049bfc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void load </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> & </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classOpenMS_1_1ProteinIdentification.html">ProteinIdentification</a> & </td>
<td class="paramname"><em>protein_identification</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector< <a class="el" href="classOpenMS_1_1PeptideIdentification.html">PeptideIdentification</a> > & </td>
<td class="paramname"><em>id_data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads a OMSSA file. </p>
<p><code>filename</code> the name of the file to read from <code>protein_identification</code> the protein <a class="el" href="classOpenMS_1_1ProteinIdentification.html" title="Representation of a protein identification run. ">ProteinIdentification</a> data <code>id_data</code> the peptide ids of the file</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">FileNotFound</td><td>is thrown if the given file could not be found </td></tr>
<tr><td class="paramname">ParseError</td><td>is thrown if the given file could not be parsed </td></tr>
</table>
</dd>
</dl>
</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:31 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
