3
<TITLE>FidHandler 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="namespaceOpenMS_1_1Internal.html">Internal</a></li><li class="navelem"><a class="el" href="classOpenMS_1_1Internal_1_1FidHandler.html">FidHandler</a></li> </ul>
24
<a href="#pub-methods">Public Member Functions</a> |
25
<a href="#pri-methods">Private Member Functions</a> |
26
<a href="#pri-attribs">Private Attributes</a> |
27
<a href="classOpenMS_1_1Internal_1_1FidHandler-members.html">List of all members</a> </div>
28
<div class="headertitle">
29
<div class="title">FidHandler Class Reference</div> </div>
31
<div class="contents">
33
<p>Read-only fid <a class="el" href="classOpenMS_1_1File.html" title="Basic file handling operations. ">File</a> handler for XMass Analysis.
34
<a href="classOpenMS_1_1Internal_1_1FidHandler.html#details">More...</a></p>
36
<p><code>#include <<a class="el" href="FidHandler_8h_source.html">OpenMS/FORMAT/HANDLERS/FidHandler.h</a>></code></p>
37
<div class="dynheader">
38
Inheritance diagram for FidHandler:</div>
39
<div class="dyncontent">
41
<img src="classOpenMS_1_1Internal_1_1FidHandler.png" usemap="#FidHandler_map" alt=""/>
42
<map id="FidHandler_map" name="FidHandler_map">
45
<table class="memberdecls">
46
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
47
Public Member Functions</h2></td></tr>
48
<tr class="memitem:a054ccbde63d4b3149fd44400bdd837aa"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Internal_1_1FidHandler.html#a054ccbde63d4b3149fd44400bdd837aa">FidHandler</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &filename)</td></tr>
49
<tr class="memdesc:a054ccbde63d4b3149fd44400bdd837aa"><td class="mdescLeft"> </td><td class="mdescRight">Contructor with filename. <a href="#a054ccbde63d4b3149fd44400bdd837aa">More...</a><br/></td></tr>
50
<tr class="separator:a054ccbde63d4b3149fd44400bdd837aa"><td class="memSeparator" colspan="2"> </td></tr>
51
<tr class="memitem:a0906a17536d805a63e1a56cf45c04e4e"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Internal_1_1FidHandler.html#a0906a17536d805a63e1a56cf45c04e4e">~FidHandler</a> ()</td></tr>
52
<tr class="memdesc:a0906a17536d805a63e1a56cf45c04e4e"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a0906a17536d805a63e1a56cf45c04e4e">More...</a><br/></td></tr>
53
<tr class="separator:a0906a17536d805a63e1a56cf45c04e4e"><td class="memSeparator" colspan="2"> </td></tr>
54
<tr class="memitem:ac969b80b2c73a201d77b39da107e461b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Internal_1_1FidHandler.html#ac969b80b2c73a201d77b39da107e461b">getIndex</a> ()</td></tr>
55
<tr class="memdesc:ac969b80b2c73a201d77b39da107e461b"><td class="mdescLeft"> </td><td class="mdescRight">Get index of current position (without position moving). <a href="#ac969b80b2c73a201d77b39da107e461b">More...</a><br/></td></tr>
56
<tr class="separator:ac969b80b2c73a201d77b39da107e461b"><td class="memSeparator" colspan="2"> </td></tr>
57
<tr class="memitem:a667c1efc1216fe89350491f7f1e5303c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Internal_1_1FidHandler.html#a667c1efc1216fe89350491f7f1e5303c">getIntensity</a> ()</td></tr>
58
<tr class="memdesc:a667c1efc1216fe89350491f7f1e5303c"><td class="mdescLeft"> </td><td class="mdescRight">Get intensity of current position and move to next position. <a href="#a667c1efc1216fe89350491f7f1e5303c">More...</a><br/></td></tr>
59
<tr class="separator:a667c1efc1216fe89350491f7f1e5303c"><td class="memSeparator" colspan="2"> </td></tr>
60
</table><table class="memberdecls">
61
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
62
Private Member Functions</h2></td></tr>
63
<tr class="memitem:a5803e9aa15a7ed1ef338887c85c1e4f4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Internal_1_1FidHandler.html#a5803e9aa15a7ed1ef338887c85c1e4f4">FidHandler</a> ()</td></tr>
64
<tr class="memdesc:a5803e9aa15a7ed1ef338887c85c1e4f4"><td class="mdescLeft"> </td><td class="mdescRight">Private default constructor. <a href="#a5803e9aa15a7ed1ef338887c85c1e4f4">More...</a><br/></td></tr>
65
<tr class="separator:a5803e9aa15a7ed1ef338887c85c1e4f4"><td class="memSeparator" colspan="2"> </td></tr>
66
</table><table class="memberdecls">
67
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
68
Private Attributes</h2></td></tr>
69
<tr class="memitem:a8499544e603bf831c56d2c3414e456ae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Internal_1_1FidHandler.html#a8499544e603bf831c56d2c3414e456ae">index_</a></td></tr>
70
<tr class="memdesc:a8499544e603bf831c56d2c3414e456ae"><td class="mdescLeft"> </td><td class="mdescRight">Index of position. <a href="#a8499544e603bf831c56d2c3414e456ae">More...</a><br/></td></tr>
71
<tr class="separator:a8499544e603bf831c56d2c3414e456ae"><td class="memSeparator" colspan="2"> </td></tr>
73
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
74
<div class="textblock"><p>Read-only fid <a class="el" href="classOpenMS_1_1File.html" title="Basic file handling operations. ">File</a> handler for XMass Analysis. </p>
75
<p>fid <a class="el" href="classOpenMS_1_1File.html" title="Basic file handling operations. ">File</a> contains intensity array. Intensity for each point are coded in 4 bytes integer.</p>
76
<dl class="section note"><dt>Note</dt><dd>Do not use this class directly. It is only needed for <a class="el" href="classOpenMS_1_1XMassFile.html" title="File adapter for 'XMass Analysis (fid)' files. ">XMassFile</a>. </dd></dl>
77
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
78
<a class="anchor" id="a054ccbde63d4b3149fd44400bdd837aa"></a>
80
<div class="memproto">
81
<table class="memname">
83
<td class="memname"><a class="el" href="classOpenMS_1_1Internal_1_1FidHandler.html">FidHandler</a> </td>
85
<td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> & </td>
86
<td class="paramname"><em>filename</em></td><td>)</td>
90
</div><div class="memdoc">
92
<p>Contructor with filename. </p>
93
<p>Open fid <a class="el" href="classOpenMS_1_1File.html" title="Basic file handling operations. ">File</a> as stream and initialize index.</p>
94
<dl class="params"><dt>Parameters</dt><dd>
95
<table class="params">
96
<tr><td class="paramname">filename</td><td>to fid <a class="el" href="classOpenMS_1_1File.html" title="Basic file handling operations. ">File</a>. </td></tr>
103
<a class="anchor" id="a0906a17536d805a63e1a56cf45c04e4e"></a>
104
<div class="memitem">
105
<div class="memproto">
106
<table class="mlabels">
108
<td class="mlabels-left">
109
<table class="memname">
111
<td class="memname">virtual ~<a class="el" href="classOpenMS_1_1Internal_1_1FidHandler.html">FidHandler</a> </td>
113
<td class="paramname"></td><td>)</td>
118
<td class="mlabels-right">
119
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
122
</div><div class="memdoc">
128
<a class="anchor" id="a5803e9aa15a7ed1ef338887c85c1e4f4"></a>
129
<div class="memitem">
130
<div class="memproto">
131
<table class="mlabels">
133
<td class="mlabels-left">
134
<table class="memname">
136
<td class="memname"><a class="el" href="classOpenMS_1_1Internal_1_1FidHandler.html">FidHandler</a> </td>
138
<td class="paramname"></td><td>)</td>
143
<td class="mlabels-right">
144
<span class="mlabels"><span class="mlabel">private</span></span> </td>
147
</div><div class="memdoc">
149
<p>Private default constructor. </p>
153
<h2 class="groupheader">Member Function Documentation</h2>
154
<a class="anchor" id="ac969b80b2c73a201d77b39da107e461b"></a>
155
<div class="memitem">
156
<div class="memproto">
157
<table class="memname">
159
<td class="memname"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> getIndex </td>
161
<td class="paramname"></td><td>)</td>
165
</div><div class="memdoc">
167
<p>Get index of current position (without position moving). </p>
171
<a class="anchor" id="a667c1efc1216fe89350491f7f1e5303c"></a>
172
<div class="memitem">
173
<div class="memproto">
174
<table class="memname">
176
<td class="memname"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> getIntensity </td>
178
<td class="paramname"></td><td>)</td>
182
</div><div class="memdoc">
184
<p>Get intensity of current position and move to next position. </p>
188
<h2 class="groupheader">Member Data Documentation</h2>
189
<a class="anchor" id="a8499544e603bf831c56d2c3414e456ae"></a>
190
<div class="memitem">
191
<div class="memproto">
192
<table class="mlabels">
194
<td class="mlabels-left">
195
<table class="memname">
197
<td class="memname"><a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> index_</td>
201
<td class="mlabels-right">
202
<span class="mlabels"><span class="mlabel">private</span></span> </td>
205
</div><div class="memdoc">
207
<p>Index of position. </p>
211
</div><!-- contents -->
212
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
213
<TABLE width="100%" border="0">
215
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
216
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:37 using doxygen 1.8.5</font></TD>
added
removed
doc/html/classOpenMS_1_1Internal_1_1FidHandler.html
