3
<TITLE>PersistentObject.h Source File</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="dir_e770f0cf77e550adde3f44739ef529fe.html">include</a></li><li class="navelem"><a class="el" href="dir_6a63c4937d4da007e55fff5dcf71e0f8.html">OpenMS</a></li><li class="navelem"><a class="el" href="dir_d1695c75ee0aa48d87e52f45c7decd7a.html">FORMAT</a></li><li class="navelem"><a class="el" href="dir_9f312478371ba173e8b03147b49034f8.html">DB</a></li> </ul>
23
<div class="headertitle">
24
<div class="title">PersistentObject.h</div> </div>
26
<div class="contents">
27
<a href="PersistentObject_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// --------------------------------------------------------------------------</span></div>
28
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// OpenMS -- Open-Source Mass Spectrometry</span></div>
29
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">// --------------------------------------------------------------------------</span></div>
30
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,</span></div>
31
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// ETH Zurich, and Freie Universitaet Berlin 2002-2013.</span></div>
32
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">//</span></div>
33
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// This software is released under a three-clause BSD license:</span></div>
34
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// * Redistributions of source code must retain the above copyright</span></div>
35
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// notice, this list of conditions and the following disclaimer.</span></div>
36
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// * Redistributions in binary form must reproduce the above copyright</span></div>
37
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// notice, this list of conditions and the following disclaimer in the</span></div>
38
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">// documentation and/or other materials provided with the distribution.</span></div>
39
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// * Neither the name of any author or any participating institution</span></div>
40
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// may be used to endorse or promote products derived from this software</span></div>
41
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// without specific prior written permission.</span></div>
42
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// For a full list of authors, refer to the file AUTHORS.</span></div>
43
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// --------------------------------------------------------------------------</span></div>
44
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"</span></div>
45
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div>
46
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div>
47
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING</span></div>
48
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span></div>
49
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span></div>
50
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;</span></div>
51
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,</span></div>
52
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR</span></div>
53
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF</span></div>
54
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
55
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">//</span></div>
56
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// --------------------------------------------------------------------------</span></div>
57
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// $Maintainer: $</span></div>
58
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// $Authors: Marc Sturm $</span></div>
59
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// --------------------------------------------------------------------------</span></div>
60
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
61
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#ifndef OPENMS_FORMAT_DB_PERSISTENTOBJECT_H</span></div>
62
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor"></span><span class="preprocessor">#define OPENMS_FORMAT_DB_PERSISTENTOBJECT_H</span></div>
63
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor"></span></div>
64
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#include <<a class="code" href="Types_8h.html">OpenMS/CONCEPT/Types.h</a>></span></div>
65
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#include <<a class="code" href="Exception_8h.html">OpenMS/CONCEPT/Exception.h</a>></span></div>
66
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
67
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#include <iostream></span></div>
68
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
69
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">namespace </span>OpenMS</div>
70
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> {</div>
71
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classOpenMS_1_1PersistentObject.html"> 52</a></span>  <span class="keyword">class </span>OPENMS_DLLAPI <a class="code" href="classOpenMS_1_1PersistentObject.html">PersistentObject</a></div>
72
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  {</div>
73
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
74
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">public</span>:</div>
75
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <a class="code" href="classOpenMS_1_1PersistentObject.html">PersistentObject</a>();</div>
76
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
77
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">virtual</span> ~<a class="code" href="classOpenMS_1_1PersistentObject.html">PersistentObject</a>();</div>
78
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
79
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="classOpenMS_1_1PersistentObject.html">PersistentObject</a> & operator=(<span class="keyword">const</span> <a class="code" href="classOpenMS_1_1PersistentObject.html">PersistentObject</a> & rhs);</div>
80
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
81
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">const</span> <a class="code" href="group__Concept.html#gab5658a38464ac4e09c792c26840150f1">UID</a> & getPersistenceId() <span class="keyword">const</span>;</div>
82
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
83
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">void</span> setPersistenceId(<span class="keyword">const</span> <a class="code" href="group__Concept.html#gab5658a38464ac4e09c792c26840150f1">UID</a> & persistence_id);</div>
84
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
85
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">void</span> clearId(<span class="keywordtype">bool</span> deep = <span class="keyword">true</span>);</div>
86
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div>
87
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="keyword">protected</span>:</div>
88
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
89
<div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="classOpenMS_1_1PersistentObject.html#af3010751b605ab1544b527f76a49c6a7"> 93</a></span>  <a class="code" href="group__Concept.html#gab5658a38464ac4e09c792c26840150f1">UID</a> <a class="code" href="classOpenMS_1_1PersistentObject.html#af3010751b605ab1544b527f76a49c6a7">persistence_id_</a>;</div>
90
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
91
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> clearChildIds_() = 0;</div>
92
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  };</div>
93
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div>
94
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> }</div>
95
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="preprocessor">#endif</span></div>
96
<div class="ttc" id="Types_8h_html"><div class="ttname"><a href="Types_8h.html">Types.h</a></div></div>
97
<div class="ttc" id="classOpenMS_1_1PersistentObject_html"><div class="ttname"><a href="classOpenMS_1_1PersistentObject.html">OpenMS::PersistentObject</a></div><div class="ttdoc">Base class for all persistent objects. </div><div class="ttdef"><b>Definition:</b> PersistentObject.h:52</div></div>
98
<div class="ttc" id="classOpenMS_1_1PersistentObject_html_af3010751b605ab1544b527f76a49c6a7"><div class="ttname"><a href="classOpenMS_1_1PersistentObject.html#af3010751b605ab1544b527f76a49c6a7">OpenMS::PersistentObject::persistence_id_</a></div><div class="ttdeci">UID persistence_id_</div><div class="ttdoc">A persistence id used to refer the data back to the source. </div><div class="ttdef"><b>Definition:</b> PersistentObject.h:93</div></div>
99
<div class="ttc" id="Exception_8h_html"><div class="ttname"><a href="Exception_8h.html">Exception.h</a></div></div>
100
<div class="ttc" id="group__Concept_html_gab5658a38464ac4e09c792c26840150f1"><div class="ttname"><a href="group__Concept.html#gab5658a38464ac4e09c792c26840150f1">OpenMS::UID</a></div><div class="ttdeci">OPENMS_UINT64_TYPE UID</div><div class="ttdoc">A unique object ID (as unsigned 64bit type). </div><div class="ttdef"><b>Definition:</b> Types.h:137</div></div>
101
</div><!-- fragment --></div><!-- contents -->
102
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
103
<TABLE width="100%" border="0">
105
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
106
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:19 using doxygen 1.8.5</font></TD>
added
removed
doc/html/PersistentObject_8h_source.html
