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
|
<HTML>
<HEAD>
<TITLE>FASTAFile 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_1FASTAFile.html">FASTAFile</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classOpenMS_1_1FASTAFile-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">FASTAFile Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class serves for reading in FASTA files.
<a href="classOpenMS_1_1FASTAFile.html#details">More...</a></p>
<p><code>#include <<a class="el" href="FASTAFile_8h_source.html">OpenMS/FORMAT/FASTAFile.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenMS_1_1FASTAFile_1_1FASTAEntry.html">FASTAEntry</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">FASTA entry type (identifier, description and sequence) <a href="structOpenMS_1_1FASTAFile_1_1FASTAEntry.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:aea91872acc649b1897ad4a8ee088f07d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1FASTAFile.html#aea91872acc649b1897ad4a8ee088f07d">FASTAFile</a> ()</td></tr>
<tr class="memdesc:aea91872acc649b1897ad4a8ee088f07d"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#aea91872acc649b1897ad4a8ee088f07d">More...</a><br/></td></tr>
<tr class="separator:aea91872acc649b1897ad4a8ee088f07d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f035af4fd9fff510ed0aae769600689"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1FASTAFile.html#a8f035af4fd9fff510ed0aae769600689">~FASTAFile</a> ()</td></tr>
<tr class="memdesc:a8f035af4fd9fff510ed0aae769600689"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a8f035af4fd9fff510ed0aae769600689">More...</a><br/></td></tr>
<tr class="separator:a8f035af4fd9fff510ed0aae769600689"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a744a1b0412d98fc89ea1a707dea4dfca"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1FASTAFile.html#a744a1b0412d98fc89ea1a707dea4dfca">load</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &filename, std::vector< <a class="el" href="structOpenMS_1_1FASTAFile_1_1FASTAEntry.html">FASTAEntry</a> > &data)</td></tr>
<tr class="memdesc:a744a1b0412d98fc89ea1a707dea4dfca"><td class="mdescLeft"> </td><td class="mdescRight">loads a FASTA file given by 'filename' and stores the information in 'data' <a href="#a744a1b0412d98fc89ea1a707dea4dfca">More...</a><br/></td></tr>
<tr class="separator:a744a1b0412d98fc89ea1a707dea4dfca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a01666aa3062d6e20a48b1c776151f7d8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1FASTAFile.html#a01666aa3062d6e20a48b1c776151f7d8">store</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &filename, const std::vector< <a class="el" href="structOpenMS_1_1FASTAFile_1_1FASTAEntry.html">FASTAEntry</a> > &data) const </td></tr>
<tr class="memdesc:a01666aa3062d6e20a48b1c776151f7d8"><td class="mdescLeft"> </td><td class="mdescRight">stores the data given by 'data' at the file 'filename' <a href="#a01666aa3062d6e20a48b1c776151f7d8">More...</a><br/></td></tr>
<tr class="separator:a01666aa3062d6e20a48b1c776151f7d8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class serves for reading in FASTA files. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="aea91872acc649b1897ad4a8ee088f07d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1FASTAFile.html">FASTAFile</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
</div>
</div>
<a class="anchor" id="a8f035af4fd9fff510ed0aae769600689"></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_1FASTAFile.html">FASTAFile</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="a744a1b0412d98fc89ea1a707dea4dfca"></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">std::vector< <a class="el" href="structOpenMS_1_1FASTAFile_1_1FASTAEntry.html">FASTAEntry</a> > & </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>loads a FASTA file given by 'filename' and stores the information in 'data' </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classOpenMS_1_1Exception_1_1FileNotFound.html" title="File not found exception. ">Exception::FileNotFound</a></td><td>is thrown if the file does not exists. </td></tr>
<tr><td class="paramname"><a class="el" href="classOpenMS_1_1Exception_1_1ParseError.html" title="Parse Error exception. ">Exception::ParseError</a></td><td>is thrown if the file does not suit to the standard. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a01666aa3062d6e20a48b1c776151f7d8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void store </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">const std::vector< <a class="el" href="structOpenMS_1_1FASTAFile_1_1FASTAEntry.html">FASTAEntry</a> > & </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>stores the data given by 'data' at the file 'filename' </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classOpenMS_1_1Exception_1_1UnableToCreateFile.html" title="Unable to create file exception. ">Exception::UnableToCreateFile</a></td><td>is thrown if the process is not able to write the file. </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:30 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
