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
|
<HTML>
<HEAD>
<TITLE>PTMXMLFile 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_1PTMXMLFile.html">PTMXMLFile</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classOpenMS_1_1PTMXMLFile-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PTMXMLFile Class Reference<div class="ingroups"><a class="el" href="group__FileIO.html">File IO</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Used to load and store PTMXML files.
<a href="classOpenMS_1_1PTMXMLFile.html#details">More...</a></p>
<p><code>#include <<a class="el" href="PTMXMLFile_8h_source.html">OpenMS/FORMAT/PTMXMLFile.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for PTMXMLFile:</div>
<div class="dyncontent">
<div class="center">
<img src="classOpenMS_1_1PTMXMLFile.png" usemap="#PTMXMLFile_map" alt=""/>
<map id="PTMXMLFile_map" name="PTMXMLFile_map">
<area href="classOpenMS_1_1Internal_1_1XMLFile.html" title="Base class for loading/storing XML files that have a handler derived from XMLHandler. " alt="XMLFile" shape="rect" coords="0,0,86,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:a95238e6bac560629891b6efb6b29c774"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1PTMXMLFile.html#a95238e6bac560629891b6efb6b29c774">PTMXMLFile</a> ()</td></tr>
<tr class="memdesc:a95238e6bac560629891b6efb6b29c774"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a95238e6bac560629891b6efb6b29c774">More...</a><br/></td></tr>
<tr class="separator:a95238e6bac560629891b6efb6b29c774"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab234b77a89f7e1ba8309b897043837ce"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1PTMXMLFile.html#ab234b77a89f7e1ba8309b897043837ce">load</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &filename, std::map< <a class="el" href="classOpenMS_1_1String.html">String</a>, std::pair< <a class="el" href="classOpenMS_1_1String.html">String</a>, <a class="el" href="classOpenMS_1_1String.html">String</a> > > &ptm_informations)</td></tr>
<tr class="memdesc:ab234b77a89f7e1ba8309b897043837ce"><td class="mdescLeft"> </td><td class="mdescRight">Loads the informations of a PTMXML file. <a href="#ab234b77a89f7e1ba8309b897043837ce">More...</a><br/></td></tr>
<tr class="separator:ab234b77a89f7e1ba8309b897043837ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9a6e2d5feb4e531787d755ebf460d1a1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1PTMXMLFile.html#a9a6e2d5feb4e531787d755ebf460d1a1">store</a> (<a class="el" href="classOpenMS_1_1String.html">String</a> filename, std::map< <a class="el" href="classOpenMS_1_1String.html">String</a>, std::pair< <a class="el" href="classOpenMS_1_1String.html">String</a>, <a class="el" href="classOpenMS_1_1String.html">String</a> > > &ptm_informations) const </td></tr>
<tr class="memdesc:a9a6e2d5feb4e531787d755ebf460d1a1"><td class="mdescLeft"> </td><td class="mdescRight">Stores the data in an PTMXML file. <a href="#a9a6e2d5feb4e531787d755ebf460d1a1">More...</a><br/></td></tr>
<tr class="separator:a9a6e2d5feb4e531787d755ebf460d1a1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classOpenMS_1_1Internal_1_1XMLFile"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classOpenMS_1_1Internal_1_1XMLFile')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classOpenMS_1_1Internal_1_1XMLFile.html">XMLFile</a></td></tr>
<tr class="memitem:a5288a663fb130ba112c205bd7c556fd4 inherit pub_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Internal_1_1XMLFile.html#a5288a663fb130ba112c205bd7c556fd4">XMLFile</a> ()</td></tr>
<tr class="memdesc:a5288a663fb130ba112c205bd7c556fd4 inherit pub_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a5288a663fb130ba112c205bd7c556fd4">More...</a><br/></td></tr>
<tr class="separator:a5288a663fb130ba112c205bd7c556fd4 inherit pub_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6a2f018df297124fba778512994282a inherit pub_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Internal_1_1XMLFile.html#ab6a2f018df297124fba778512994282a">XMLFile</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &schema_location, const <a class="el" href="classOpenMS_1_1String.html">String</a> &version)</td></tr>
<tr class="memdesc:ab6a2f018df297124fba778512994282a inherit pub_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="mdescLeft"> </td><td class="mdescRight">Constructor that sets the schema location. <a href="#ab6a2f018df297124fba778512994282a">More...</a><br/></td></tr>
<tr class="separator:ab6a2f018df297124fba778512994282a inherit pub_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae64064342fc97bdd2008c5a91cd6d9de inherit pub_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Internal_1_1XMLFile.html#ae64064342fc97bdd2008c5a91cd6d9de">~XMLFile</a> ()</td></tr>
<tr class="memdesc:ae64064342fc97bdd2008c5a91cd6d9de inherit pub_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ae64064342fc97bdd2008c5a91cd6d9de">More...</a><br/></td></tr>
<tr class="separator:ae64064342fc97bdd2008c5a91cd6d9de inherit pub_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f3216da86d8ced03f1b102a5c2e886c inherit pub_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Internal_1_1XMLFile.html#a2f3216da86d8ced03f1b102a5c2e886c">isValid</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &filename, std::ostream &os=std::cerr)</td></tr>
<tr class="memdesc:a2f3216da86d8ced03f1b102a5c2e886c inherit pub_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a file validates against the XML schema. <a href="#a2f3216da86d8ced03f1b102a5c2e886c">More...</a><br/></td></tr>
<tr class="separator:a2f3216da86d8ced03f1b102a5c2e886c inherit pub_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae6b3b4b6857bc1987282e2f29611dd41 inherit pub_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classOpenMS_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Internal_1_1XMLFile.html#ae6b3b4b6857bc1987282e2f29611dd41">getVersion</a> () const </td></tr>
<tr class="memdesc:ae6b3b4b6857bc1987282e2f29611dd41 inherit pub_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="mdescLeft"> </td><td class="mdescRight">return the version of the schema <a href="#ae6b3b4b6857bc1987282e2f29611dd41">More...</a><br/></td></tr>
<tr class="separator:ae6b3b4b6857bc1987282e2f29611dd41 inherit pub_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classOpenMS_1_1Internal_1_1XMLFile"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classOpenMS_1_1Internal_1_1XMLFile')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classOpenMS_1_1Internal_1_1XMLFile.html">XMLFile</a></td></tr>
<tr class="memitem:ab08cc6e67bde4d478045ece950deb32b inherit pro_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Internal_1_1XMLFile.html#ab08cc6e67bde4d478045ece950deb32b">parse_</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &filename, <a class="el" href="classOpenMS_1_1Internal_1_1XMLHandler.html">XMLHandler</a> *handler)</td></tr>
<tr class="memdesc:ab08cc6e67bde4d478045ece950deb32b inherit pro_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="mdescLeft"> </td><td class="mdescRight">Parses the XML file given by <code>filename</code> using the handler given by <code>handler</code>. <a href="#ab08cc6e67bde4d478045ece950deb32b">More...</a><br/></td></tr>
<tr class="separator:ab08cc6e67bde4d478045ece950deb32b inherit pro_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa99a8fa1726ecc3b865167eea1c17db7 inherit pro_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Internal_1_1XMLFile.html#aa99a8fa1726ecc3b865167eea1c17db7">save_</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &filename, <a class="el" href="classOpenMS_1_1Internal_1_1XMLHandler.html">XMLHandler</a> *handler) const </td></tr>
<tr class="memdesc:aa99a8fa1726ecc3b865167eea1c17db7 inherit pro_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="mdescLeft"> </td><td class="mdescRight">Stores the contents of the XML handler given by <code>handler</code> in the file given by <code>filename</code>. <a href="#aa99a8fa1726ecc3b865167eea1c17db7">More...</a><br/></td></tr>
<tr class="separator:aa99a8fa1726ecc3b865167eea1c17db7 inherit pro_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a97478c2a7b5ed960dae2ac5da0c03045 inherit pro_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Internal_1_1XMLFile.html#a97478c2a7b5ed960dae2ac5da0c03045">enforceEncoding_</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &encoding)</td></tr>
<tr class="separator:a97478c2a7b5ed960dae2ac5da0c03045 inherit pro_methods_classOpenMS_1_1Internal_1_1XMLFile"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_attribs_classOpenMS_1_1Internal_1_1XMLFile"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classOpenMS_1_1Internal_1_1XMLFile')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classOpenMS_1_1Internal_1_1XMLFile.html">XMLFile</a></td></tr>
<tr class="memitem:aea8dd5b28e6057c3e2b3f296966431c3 inherit pro_attribs_classOpenMS_1_1Internal_1_1XMLFile"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Internal_1_1XMLFile.html#aea8dd5b28e6057c3e2b3f296966431c3">schema_location_</a></td></tr>
<tr class="memdesc:aea8dd5b28e6057c3e2b3f296966431c3 inherit pro_attribs_classOpenMS_1_1Internal_1_1XMLFile"><td class="mdescLeft"> </td><td class="mdescRight">XML schema file location. <a href="#aea8dd5b28e6057c3e2b3f296966431c3">More...</a><br/></td></tr>
<tr class="separator:aea8dd5b28e6057c3e2b3f296966431c3 inherit pro_attribs_classOpenMS_1_1Internal_1_1XMLFile"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a33231ac1616a429e6533af15231951 inherit pro_attribs_classOpenMS_1_1Internal_1_1XMLFile"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Internal_1_1XMLFile.html#a5a33231ac1616a429e6533af15231951">schema_version_</a></td></tr>
<tr class="memdesc:a5a33231ac1616a429e6533af15231951 inherit pro_attribs_classOpenMS_1_1Internal_1_1XMLFile"><td class="mdescLeft"> </td><td class="mdescRight">Version string. <a href="#a5a33231ac1616a429e6533af15231951">More...</a><br/></td></tr>
<tr class="separator:a5a33231ac1616a429e6533af15231951 inherit pro_attribs_classOpenMS_1_1Internal_1_1XMLFile"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b0159bfc4bc3062d47825cccfeec9cd inherit pro_attribs_classOpenMS_1_1Internal_1_1XMLFile"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Internal_1_1XMLFile.html#a6b0159bfc4bc3062d47825cccfeec9cd">enforced_encoding_</a></td></tr>
<tr class="memdesc:a6b0159bfc4bc3062d47825cccfeec9cd inherit pro_attribs_classOpenMS_1_1Internal_1_1XMLFile"><td class="mdescLeft"> </td><td class="mdescRight">Encoding string that replaces the encoding (system dependend or specified in the XML). Disabled if empty. Used as a workaround for XTandem output xml. <a href="#a6b0159bfc4bc3062d47825cccfeec9cd">More...</a><br/></td></tr>
<tr class="separator:a6b0159bfc4bc3062d47825cccfeec9cd inherit pro_attribs_classOpenMS_1_1Internal_1_1XMLFile"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Used to load and store PTMXML files. </p>
<p>This class is used to load and store documents that implement the schema of PTMXML files. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a95238e6bac560629891b6efb6b29c774"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1PTMXMLFile.html">PTMXMLFile</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab234b77a89f7e1ba8309b897043837ce"></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::map< <a class="el" href="classOpenMS_1_1String.html">String</a>, std::pair< <a class="el" href="classOpenMS_1_1String.html">String</a>, <a class="el" href="classOpenMS_1_1String.html">String</a> > > & </td>
<td class="paramname"><em>ptm_informations</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads the informations of a PTMXML file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>The name of the file </td></tr>
<tr><td class="paramname">ptm_informations</td><td>the PTM information from the file are stored herein </td></tr>
</table>
</dd>
</dl>
<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 The information is read in and stored in the corresponding variables </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9a6e2d5feb4e531787d755ebf460d1a1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void store </td>
<td>(</td>
<td class="paramtype"><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::map< <a class="el" href="classOpenMS_1_1String.html">String</a>, std::pair< <a class="el" href="classOpenMS_1_1String.html">String</a>, <a class="el" href="classOpenMS_1_1String.html">String</a> > > & </td>
<td class="paramname"><em>ptm_informations</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Stores the data in an PTMXML file. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">UnableToCreateFile</td><td>is thrown if the given filename could not be created</td></tr>
</table>
</dd>
</dl>
<p>The data is read in and stored in the file 'filename'. </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:31 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
