File: classOpenMS_1_1HasPrecursorCharge.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 (191 lines) | stat: -rw-r--r-- 9,072 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
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
 
<HTML>
<HEAD>
<TITLE>HasPrecursorCharge&lt; SpectrumType &gt; Class Template 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> &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="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="classOpenMS_1_1HasPrecursorCharge.html">HasPrecursorCharge</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classOpenMS_1_1HasPrecursorCharge-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">HasPrecursorCharge&lt; SpectrumType &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__RangeUtils.html">RangeUtils</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Predicate that determines if a spectrum has a certain precursor charge as given in the constructor list.  
 <a href="classOpenMS_1_1HasPrecursorCharge.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="RangeUtils_8h_source.html">OpenMS/KERNEL/RangeUtils.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for HasPrecursorCharge&lt; SpectrumType &gt;:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classOpenMS_1_1HasPrecursorCharge.png" usemap="#HasPrecursorCharge&lt; SpectrumType &gt;_map" alt=""/>
  <map id="HasPrecursorCharge&lt; SpectrumType &gt;_map" name="HasPrecursorCharge&lt; SpectrumType &gt;_map">
</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:a95703fbca9243e068b37d09f362bfee1"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1HasPrecursorCharge.html#a95703fbca9243e068b37d09f362bfee1">HasPrecursorCharge</a> (const <a class="el" href="classOpenMS_1_1IntList.html">IntList</a> &amp;charges, bool reverse=false)</td></tr>
<tr class="memdesc:a95703fbca9243e068b37d09f362bfee1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a95703fbca9243e068b37d09f362bfee1">More...</a><br/></td></tr>
<tr class="separator:a95703fbca9243e068b37d09f362bfee1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a528f4cce86dd2fc219649be04f2c78ad"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1HasPrecursorCharge.html#a528f4cce86dd2fc219649be04f2c78ad">operator()</a> (const SpectrumType &amp;s) const </td></tr>
<tr class="separator:a528f4cce86dd2fc219649be04f2c78ad"><td class="memSeparator" colspan="2">&#160;</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:ab2809778b02670dc8d16e3af74e654ba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1IntList.html">IntList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1HasPrecursorCharge.html#ab2809778b02670dc8d16e3af74e654ba">charges_</a></td></tr>
<tr class="separator:ab2809778b02670dc8d16e3af74e654ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeae704668ea77ad91c0d84485ef7677e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1HasPrecursorCharge.html#aeae704668ea77ad91c0d84485ef7677e">reverse_</a></td></tr>
<tr class="separator:aeae704668ea77ad91c0d84485ef7677e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class SpectrumType&gt;<br/>
class OpenMS::HasPrecursorCharge&lt; SpectrumType &gt;</h3>

<p>Predicate that determines if a spectrum has a certain precursor charge as given in the constructor list. </p>
<p>SpectrumType must have a getPrecursors() method </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a95703fbca9243e068b37d09f362bfee1"></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="classOpenMS_1_1HasPrecursorCharge.html">HasPrecursorCharge</a> </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1IntList.html">IntList</a> &amp;&#160;</td>
          <td class="paramname"><em>charges</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>reverse</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">charges</td><td>List of charges that is compared against precursor charge. </td></tr>
    <tr><td class="paramname">reverse</td><td>if <code>reverse</code> is true, operator() returns true if the spectrum has not one of the specified precursor charges. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a528f4cce86dd2fc219649be04f2c78ad"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool operator() </td>
          <td>(</td>
          <td class="paramtype">const SpectrumType &amp;&#160;</td>
          <td class="paramname"><em>s</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>References <a class="el" href="classOpenMS_1_1HasPrecursorCharge.html#ab2809778b02670dc8d16e3af74e654ba">HasPrecursorCharge&lt; SpectrumType &gt;::charges_</a>, and <a class="el" href="classOpenMS_1_1HasPrecursorCharge.html#aeae704668ea77ad91c0d84485ef7677e">HasPrecursorCharge&lt; SpectrumType &gt;::reverse_</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ab2809778b02670dc8d16e3af74e654ba"></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="classOpenMS_1_1IntList.html">IntList</a> charges_</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>Referenced by <a class="el" href="classOpenMS_1_1HasPrecursorCharge.html#a528f4cce86dd2fc219649be04f2c78ad">HasPrecursorCharge&lt; SpectrumType &gt;::operator()()</a>.</p>

</div>
</div>
<a class="anchor" id="aeae704668ea77ad91c0d84485ef7677e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool reverse_</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>Referenced by <a class="el" href="classOpenMS_1_1HasPrecursorCharge.html#a528f4cce86dd2fc219649be04f2c78ad">HasPrecursorCharge&lt; SpectrumType &gt;::operator()()</a>.</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:32 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>