File: WeightWrapper_8h_source.html

package info (click to toggle)
openms 1.11.1-5
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 436,688 kB
  • ctags: 150,907
  • sloc: cpp: 387,126; xml: 71,547; python: 7,764; ansic: 2,626; php: 2,499; sql: 737; ruby: 342; sh: 325; makefile: 128
file content (128 lines) | stat: -rw-r--r-- 17,624 bytes parent folder | download 
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
 
<HTML>
<HEAD>
<TITLE>WeightWrapper.h Source File</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> &nbsp;&middot;
<A href="classes.html">Classes</A> &nbsp;&middot;
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
<A href="modules.html">Modules</A> &nbsp;&middot;
<A href="functions_func.html">Members</A> &nbsp;&middot;
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
<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="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_5f4b1c13d07405f47ee611fa1c92df17.html">CHEMISTRY</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">WeightWrapper.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="WeightWrapper_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>&#160;<span class="comment">// --------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">//                   OpenMS -- Open-Source Mass Spectrometry</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">// --------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">// ETH Zurich, and Freie Universitaet Berlin 2002-2013.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">// This software is released under a three-clause BSD license:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">//  * Redistributions of source code must retain the above copyright</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">//    notice, this list of conditions and the following disclaimer.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">//  * Redistributions in binary form must reproduce the above copyright</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">//    notice, this list of conditions and the following disclaimer in the</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">//    documentation and/or other materials provided with the distribution.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">//  * Neither the name of any author or any participating institution</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">//    may be used to endorse or promote products derived from this software</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">//    without specific prior written permission.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">// For a full list of authors, refer to the file AUTHORS.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">// --------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment">// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment">// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment">// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment">// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment">// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment">// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF</span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment">// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment">// --------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment">// $Maintainer: Chris Bielow$</span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment">// $Authors: Chris Bielow $</span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment">// --------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#ifndef OPENMS_CHEMISTRY_WEIGHTWRAPPER_H</span></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define OPENMS_CHEMISTRY_WEIGHTWRAPPER_H</span></div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="EmpiricalFormula_8h.html">OpenMS/CHEMISTRY/EmpiricalFormula.h</a>&gt;</span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="AASequence_8h.html">OpenMS/CHEMISTRY/AASequence.h</a>&gt;</span></div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="keyword">namespace </span>OpenMS</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;{</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classOpenMS_1_1WeightWrapper.html">   50</a></span>&#160;  <span class="keyword">class </span>OPENMS_DLLAPI <a class="code" href="classOpenMS_1_1WeightWrapper.html">WeightWrapper</a></div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;  {</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classOpenMS_1_1WeightWrapper.html#aa0e0675e46f34052468f523f1c8aff2b">   55</a></span>&#160;    <span class="keyword">enum</span> <a class="code" href="classOpenMS_1_1WeightWrapper.html#aa0e0675e46f34052468f523f1c8aff2b">WEIGHTMODE</a> {AVERAGE = 0, MONO, SIZE_OF_WEIGHTMODE};</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;</div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;    <a class="code" href="classOpenMS_1_1WeightWrapper.html">WeightWrapper</a>();</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    <a class="code" href="classOpenMS_1_1WeightWrapper.html">WeightWrapper</a>(<span class="keyword">const</span> WEIGHTMODE weight_mode);</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    <span class="keyword">virtual</span> ~<a class="code" href="classOpenMS_1_1WeightWrapper.html">WeightWrapper</a>();</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    <a class="code" href="classOpenMS_1_1WeightWrapper.html">WeightWrapper</a>(<span class="keyword">const</span> <a class="code" href="classOpenMS_1_1WeightWrapper.html">WeightWrapper</a> &amp; source);</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;</div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    <span class="keywordtype">void</span> setWeightMode(<span class="keyword">const</span> WEIGHTMODE mode);</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;</div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;</div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;    WEIGHTMODE getWeightMode() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;    <a class="code" href="classdouble.html">DoubleReal</a> getWeight(<span class="keyword">const</span> <a class="code" href="classOpenMS_1_1AASequence.html">AASequence</a> &amp; aa) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;    <a class="code" href="classdouble.html">DoubleReal</a> getWeight(<span class="keyword">const</span> <a class="code" href="classOpenMS_1_1EmpiricalFormula.html">EmpiricalFormula</a> &amp; ef) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;</div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;    <a class="code" href="classdouble.html">DoubleReal</a> getWeight(<span class="keyword">const</span> <a class="code" href="classOpenMS_1_1Residue.html">Residue</a> &amp; r, <a class="code" href="classOpenMS_1_1Residue.html#a7651af21f9cf8ed6445415903fc6cb48">Residue::ResidueType</a> res_type = <a class="code" href="classOpenMS_1_1Residue.html#a7651af21f9cf8ed6445415903fc6cb48a8b7c5cd8bd8eb51ee6d3fd0eac584679">Residue::Full</a>) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;</div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;</div>
<div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="classOpenMS_1_1WeightWrapper.html#a12af4a94d9fb3b6c7df696adadf02281">  127</a></span>&#160;    <a class="code" href="classOpenMS_1_1WeightWrapper.html#aa0e0675e46f34052468f523f1c8aff2b">WEIGHTMODE</a> <a class="code" href="classOpenMS_1_1WeightWrapper.html#a12af4a94d9fb3b6c7df696adadf02281">weight_mode_</a>;         </div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;</div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;</div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;  };</div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;}</div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="preprocessor">#endif // OPENMS_CHEMISTRY_WeightWrapper_H</span></div>
<div class="ttc" id="EmpiricalFormula_8h_html"><div class="ttname"><a href="EmpiricalFormula_8h.html">EmpiricalFormula.h</a></div></div>
<div class="ttc" id="classdouble_html"><div class="ttname"><a href="classdouble.html">double</a></div></div>
<div class="ttc" id="AASequence_8h_html"><div class="ttname"><a href="AASequence_8h.html">AASequence.h</a></div></div>
<div class="ttc" id="classOpenMS_1_1AASequence_html"><div class="ttname"><a href="classOpenMS_1_1AASequence.html">OpenMS::AASequence</a></div><div class="ttdoc">Representation of a peptide/protein sequence. </div><div class="ttdef"><b>Definition:</b> AASequence.h:84</div></div>
<div class="ttc" id="classOpenMS_1_1Residue_html"><div class="ttname"><a href="classOpenMS_1_1Residue.html">OpenMS::Residue</a></div><div class="ttdoc">Representation of a residue. </div><div class="ttdef"><b>Definition:</b> Residue.h:64</div></div>
<div class="ttc" id="classOpenMS_1_1EmpiricalFormula_html"><div class="ttname"><a href="classOpenMS_1_1EmpiricalFormula.html">OpenMS::EmpiricalFormula</a></div><div class="ttdoc">Representation of an empirical formula. </div><div class="ttdef"><b>Definition:</b> EmpiricalFormula.h:78</div></div>
<div class="ttc" id="classOpenMS_1_1WeightWrapper_html_aa0e0675e46f34052468f523f1c8aff2b"><div class="ttname"><a href="classOpenMS_1_1WeightWrapper.html#aa0e0675e46f34052468f523f1c8aff2b">OpenMS::WeightWrapper::WEIGHTMODE</a></div><div class="ttdeci">WEIGHTMODE</div><div class="ttdef"><b>Definition:</b> WeightWrapper.h:55</div></div>
<div class="ttc" id="classOpenMS_1_1WeightWrapper_html_a12af4a94d9fb3b6c7df696adadf02281"><div class="ttname"><a href="classOpenMS_1_1WeightWrapper.html#a12af4a94d9fb3b6c7df696adadf02281">OpenMS::WeightWrapper::weight_mode_</a></div><div class="ttdeci">WEIGHTMODE weight_mode_</div><div class="ttdoc">one of WeightWrapper::WEIGHTMODE&amp;#39;s values </div><div class="ttdef"><b>Definition:</b> WeightWrapper.h:127</div></div>
<div class="ttc" id="classOpenMS_1_1Residue_html_a7651af21f9cf8ed6445415903fc6cb48a8b7c5cd8bd8eb51ee6d3fd0eac584679"><div class="ttname"><a href="classOpenMS_1_1Residue.html#a7651af21f9cf8ed6445415903fc6cb48a8b7c5cd8bd8eb51ee6d3fd0eac584679">OpenMS::Residue::Full</a></div><div class="ttdef"><b>Definition:</b> Residue.h:363</div></div>
<div class="ttc" id="classOpenMS_1_1Residue_html_a7651af21f9cf8ed6445415903fc6cb48"><div class="ttname"><a href="classOpenMS_1_1Residue.html#a7651af21f9cf8ed6445415903fc6cb48">OpenMS::Residue::ResidueType</a></div><div class="ttdeci">ResidueType</div><div class="ttdef"><b>Definition:</b> Residue.h:361</div></div>
<div class="ttc" id="classOpenMS_1_1WeightWrapper_html"><div class="ttname"><a href="classOpenMS_1_1WeightWrapper.html">OpenMS::WeightWrapper</a></div><div class="ttdoc">Encapsulated weight queries to simplify mono vs average weight computation. </div><div class="ttdef"><b>Definition:</b> WeightWrapper.h:50</div></div>
</div><!-- fragment --></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:23 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>