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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
|
<HTML>
<HEAD>
<TITLE>PersistentObject 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_1PersistentObject.html">PersistentObject</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classOpenMS_1_1PersistentObject-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PersistentObject Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__DatabaseIO.html">Database IO</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Base class for all persistent objects.
<a href="classOpenMS_1_1PersistentObject.html#details">More...</a></p>
<p><code>#include <<a class="el" href="PersistentObject_8h_source.html">OpenMS/FORMAT/DB/PersistentObject.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for PersistentObject:</div>
<div class="dyncontent">
<div class="center">
<img src="classOpenMS_1_1PersistentObject.png" usemap="#PersistentObject_map" alt=""/>
<map id="PersistentObject_map" name="PersistentObject_map">
<area href="classOpenMS_1_1MSChromatogram.html" alt="MSChromatogram< ChromatogramPeakType >" shape="rect" coords="288,56,566,80"/>
<area href="classOpenMS_1_1MSExperiment.html" alt="MSExperiment< OpenMS::Peak1D >" shape="rect" coords="288,112,566,136"/>
<area href="classOpenMS_1_1MSExperiment.html" alt="MSExperiment< Peak1D >" shape="rect" coords="288,168,566,192"/>
<area href="classOpenMS_1_1MSExperiment.html" alt="MSExperiment< SimPointType >" shape="rect" coords="288,224,566,248"/>
<area href="classOpenMS_1_1MSSpectrum.html" alt="MSSpectrum< OpenMS::Peak2D >" shape="rect" coords="288,280,566,304"/>
<area href="classOpenMS_1_1MSSpectrum.html" alt="MSSpectrum< Peak1D >" shape="rect" coords="288,336,566,360"/>
<area href="classOpenMS_1_1MSSpectrum.html" alt="MSSpectrum< PeakType >" shape="rect" coords="288,392,566,416"/>
<area href="classOpenMS_1_1MSSpectrum.html" alt="MSSpectrum< RichPeak1D >" shape="rect" coords="288,448,566,472"/>
<area href="classOpenMS_1_1MSSpectrum.html" alt="MSSpectrum<>" shape="rect" coords="288,504,566,528"/>
<area href="classOpenMS_1_1MSChromatogram.html" title="The representation of a chromatogram. " alt="MSChromatogram< PeakT >" shape="rect" coords="288,560,566,584"/>
<area href="classOpenMS_1_1MSExperiment.html" title="Representation of a mass spectrometry experiment. " alt="MSExperiment< PeakT, ChromatogramPeakT >" shape="rect" coords="288,616,566,640"/>
<area href="classOpenMS_1_1MSSpectrum.html" title="The representation of a 1D spectrum. " alt="MSSpectrum< PeakT >" shape="rect" coords="288,672,566,696"/>
</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:a7e87ad10dca0d49591d34fc0b3a7b1d8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1PersistentObject.html#a7e87ad10dca0d49591d34fc0b3a7b1d8">PersistentObject</a> ()</td></tr>
<tr class="memdesc:a7e87ad10dca0d49591d34fc0b3a7b1d8"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a7e87ad10dca0d49591d34fc0b3a7b1d8">More...</a><br/></td></tr>
<tr class="separator:a7e87ad10dca0d49591d34fc0b3a7b1d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad40e53542f2296d4210e0163d00abc19"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1PersistentObject.html#ad40e53542f2296d4210e0163d00abc19">~PersistentObject</a> ()</td></tr>
<tr class="memdesc:ad40e53542f2296d4210e0163d00abc19"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ad40e53542f2296d4210e0163d00abc19">More...</a><br/></td></tr>
<tr class="separator:ad40e53542f2296d4210e0163d00abc19"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aede71eb0c7f871a5415bb4757f8faec5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1PersistentObject.html">PersistentObject</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1PersistentObject.html#aede71eb0c7f871a5415bb4757f8faec5">operator=</a> (const <a class="el" href="classOpenMS_1_1PersistentObject.html">PersistentObject</a> &rhs)</td></tr>
<tr class="memdesc:aede71eb0c7f871a5415bb4757f8faec5"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#aede71eb0c7f871a5415bb4757f8faec5">More...</a><br/></td></tr>
<tr class="separator:aede71eb0c7f871a5415bb4757f8faec5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad90344f35ad83bd6e69af1a17883b8e5"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="group__Concept.html#gab5658a38464ac4e09c792c26840150f1">UID</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1PersistentObject.html#ad90344f35ad83bd6e69af1a17883b8e5">getPersistenceId</a> () const </td></tr>
<tr class="memdesc:ad90344f35ad83bd6e69af1a17883b8e5"><td class="mdescLeft"> </td><td class="mdescRight">Returns the persistence id. <a href="#ad90344f35ad83bd6e69af1a17883b8e5">More...</a><br/></td></tr>
<tr class="separator:ad90344f35ad83bd6e69af1a17883b8e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab1d88f1b260549db53cf50056e42dde9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1PersistentObject.html#ab1d88f1b260549db53cf50056e42dde9">setPersistenceId</a> (const <a class="el" href="group__Concept.html#gab5658a38464ac4e09c792c26840150f1">UID</a> &persistence_id)</td></tr>
<tr class="memdesc:ab1d88f1b260549db53cf50056e42dde9"><td class="mdescLeft"> </td><td class="mdescRight">Sets the persistence id. <a href="#ab1d88f1b260549db53cf50056e42dde9">More...</a><br/></td></tr>
<tr class="separator:ab1d88f1b260549db53cf50056e42dde9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad88b5f0f6c90153e67e86b0b761e54c4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1PersistentObject.html#ad88b5f0f6c90153e67e86b0b761e54c4">clearId</a> (bool deep=true)</td></tr>
<tr class="memdesc:ad88b5f0f6c90153e67e86b0b761e54c4"><td class="mdescLeft"> </td><td class="mdescRight">Clears the persistence id. <a href="#ad88b5f0f6c90153e67e86b0b761e54c4">More...</a><br/></td></tr>
<tr class="separator:ad88b5f0f6c90153e67e86b0b761e54c4"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:af4bfd2fe1ed3e2440b51fcd77cfe06f7"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1PersistentObject.html#af4bfd2fe1ed3e2440b51fcd77cfe06f7">clearChildIds_</a> ()=0</td></tr>
<tr class="memdesc:af4bfd2fe1ed3e2440b51fcd77cfe06f7"><td class="mdescLeft"> </td><td class="mdescRight">Clears the persistence id of all sub-objects. <a href="#af4bfd2fe1ed3e2440b51fcd77cfe06f7">More...</a><br/></td></tr>
<tr class="separator:af4bfd2fe1ed3e2440b51fcd77cfe06f7"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:af3010751b605ab1544b527f76a49c6a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gab5658a38464ac4e09c792c26840150f1">UID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1PersistentObject.html#af3010751b605ab1544b527f76a49c6a7">persistence_id_</a></td></tr>
<tr class="memdesc:af3010751b605ab1544b527f76a49c6a7"><td class="mdescLeft"> </td><td class="mdescRight">A persistence id used to refer the data back to the source. <a href="#af3010751b605ab1544b527f76a49c6a7">More...</a><br/></td></tr>
<tr class="separator:af3010751b605ab1544b527f76a49c6a7"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class for all persistent objects. </p>
<p>Interface for all classes that can be stored persistently in the <a class="el" href="namespaceOpenMS.html" title="Main OpenMS namespace. ">OpenMS</a> DB. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7e87ad10dca0d49591d34fc0b3a7b1d8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1PersistentObject.html">PersistentObject</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="ad40e53542f2296d4210e0163d00abc19"></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_1PersistentObject.html">PersistentObject</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="af4bfd2fe1ed3e2440b51fcd77cfe06f7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void clearChildIds_ </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears the persistence id of all sub-objects. </p>
<p>Implemented in <a class="el" href="classOpenMS_1_1MSExperiment.html#aca192a8c89187e4311eacc9daa073c7b">MSExperiment< PeakT, ChromatogramPeakT ></a>, <a class="el" href="classOpenMS_1_1MSExperiment.html#aca192a8c89187e4311eacc9daa073c7b">MSExperiment< OpenMS::Peak1D ></a>, <a class="el" href="classOpenMS_1_1MSExperiment.html#aca192a8c89187e4311eacc9daa073c7b">MSExperiment< Peak1D ></a>, <a class="el" href="classOpenMS_1_1MSExperiment.html#aca192a8c89187e4311eacc9daa073c7b">MSExperiment< SimPointType ></a>, <a class="el" href="classOpenMS_1_1MSSpectrum.html#aca192a8c89187e4311eacc9daa073c7b">MSSpectrum< PeakT ></a>, <a class="el" href="classOpenMS_1_1MSSpectrum.html#aca192a8c89187e4311eacc9daa073c7b">MSSpectrum< PeakType ></a>, <a class="el" href="classOpenMS_1_1MSSpectrum.html#aca192a8c89187e4311eacc9daa073c7b">MSSpectrum< Peak1D ></a>, <a class="el" href="classOpenMS_1_1MSSpectrum.html#aca192a8c89187e4311eacc9daa073c7b">MSSpectrum< OpenMS::Peak2D ></a>, <a class="el" href="classOpenMS_1_1MSSpectrum.html#aca192a8c89187e4311eacc9daa073c7b">MSSpectrum<></a>, <a class="el" href="classOpenMS_1_1MSSpectrum.html#aca192a8c89187e4311eacc9daa073c7b">MSSpectrum< RichPeak1D ></a>, <a class="el" href="classOpenMS_1_1MSChromatogram.html#aca192a8c89187e4311eacc9daa073c7b">MSChromatogram< PeakT ></a>, <a class="el" href="classOpenMS_1_1MSChromatogram.html#aca192a8c89187e4311eacc9daa073c7b">MSChromatogram< ChromatogramPeakType ></a>, and <a class="el" href="classOpenMS_1_1BinnedSpectrum.html#aca192a8c89187e4311eacc9daa073c7b">BinnedSpectrum</a>.</p>
</div>
</div>
<a class="anchor" id="ad88b5f0f6c90153e67e86b0b761e54c4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void clearId </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>deep</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears the persistence id. </p>
<p>Sets the id to 0.<br/>
</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">deep</td><td>determines which ids are cleared. <code>false</code> means that only the id of the current object is reset. <code>true</code> means that the ids of all sub-objects are reset as well (default). </td></tr>
</table>
</dd>
</dl>
<p>Referenced by <a class="el" href="classOpenMS_1_1MSChromatogram.html#af072fc84225ae927f7527f208ea86cbd">MSChromatogram< ChromatogramPeakType >::clear()</a>, <a class="el" href="classOpenMS_1_1MSSpectrum.html#af072fc84225ae927f7527f208ea86cbd">MSSpectrum< RichPeak1D >::clear()</a>, and <a class="el" href="classOpenMS_1_1MSExperiment.html#af072fc84225ae927f7527f208ea86cbd">MSExperiment< SimPointType >::clear()</a>.</p>
</div>
</div>
<a class="anchor" id="ad90344f35ad83bd6e69af1a17883b8e5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="group__Concept.html#gab5658a38464ac4e09c792c26840150f1">UID</a>& getPersistenceId </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the persistence id. </p>
<p>This id is only used in the <a class="el" href="classOpenMS_1_1DBAdapter.html" title="A class for accessing and storing data in a SQL database. ">DBAdapter</a> the id is used to connect the object to the data stored in the DB. </p>
</div>
</div>
<a class="anchor" id="aede71eb0c7f871a5415bb4757f8faec5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1PersistentObject.html">PersistentObject</a>& operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1PersistentObject.html">PersistentObject</a> & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Assignment operator. </p>
<p>Referenced by <a class="el" href="classOpenMS_1_1MSChromatogram.html#a451f36bed614c68ef9ac9577d6ce6a96">MSChromatogram< ChromatogramPeakType >::operator=()</a>, <a class="el" href="classOpenMS_1_1MSSpectrum.html#ae19a19c23107e1d28c2b21da4267fe61">MSSpectrum< RichPeak1D >::operator=()</a>, <a class="el" href="classOpenMS_1_1MSExperiment.html#a60095ad674632c73d7d08ebc1e2b05f5">MSExperiment< SimPointType >::operator=()</a>, and <a class="el" href="classOpenMS_1_1MSExperiment.html#a1acb534122a4490f537bd523ec7e8c74">MSExperiment< SimPointType >::swap()</a>.</p>
</div>
</div>
<a class="anchor" id="ab1d88f1b260549db53cf50056e42dde9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setPersistenceId </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__Concept.html#gab5658a38464ac4e09c792c26840150f1">UID</a> & </td>
<td class="paramname"><em>persistence_id</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the persistence id. </p>
<p>This id is only used in the <a class="el" href="classOpenMS_1_1DBAdapter.html" title="A class for accessing and storing data in a SQL database. ">DBAdapter</a> the id is used to connect the object to the data stored in the DB. <br/>
Do not set the persistence id unless you know what you are doing! </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="af3010751b605ab1544b527f76a49c6a7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Concept.html#gab5658a38464ac4e09c792c26840150f1">UID</a> persistence_id_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A persistence id used to refer the data back to the source. </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:30 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
