← Back to branch summary

~ubuntu-branches/ubuntu/wily/openms/wily

« back to all changes in this revision

Viewing changes to doc/html/classOpenMS_1_1HasScanMode.html

  • Committer: Package Import Robot
  • Author(s): Filippo Rusconi
  • Date: 2013-12-20 11:30:16 UTC
  • mfrom: (5.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20131220113016-wre5g9bteeheq6he
Tags: 1.11.1-3
* remove version number from libbost development package names;
* ensure that AUTHORS is correctly shipped in all packages.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/classOpenMS_1_1HasScanMode.html
 
1
<HTML>
 
2
<HEAD>
 
3
<TITLE>HasScanMode&lt; SpectrumType &gt; Class Template Reference</TITLE>
 
4
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
 
5
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
 
6
</HEAD>
 
7
<BODY BGCOLOR="#FFFFFF">
 
8
<A href="index.html">Home</A> &nbsp;&middot;
 
9
<A href="classes.html">Classes</A> &nbsp;&middot;
 
10
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
 
11
<A href="modules.html">Modules</A> &nbsp;&middot;
 
12
<A href="functions_func.html">Members</A> &nbsp;&middot;
 
13
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
 
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">
 
18
  <ul>
 
19
<li class="navelem"><a class="el" href="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="classOpenMS_1_1HasScanMode.html">HasScanMode</a></li>  </ul>
 
20
</div>
 
21
</div><!-- top -->
 
22
<div class="header">
 
23
  <div class="summary">
 
24
<a href="#pub-methods">Public Member Functions</a> &#124;
 
25
<a href="#pro-attribs">Protected Attributes</a> &#124;
 
26
<a href="classOpenMS_1_1HasScanMode-members.html">List of all members</a>  </div>
 
27
  <div class="headertitle">
 
28
<div class="title">HasScanMode&lt; SpectrumType &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__RangeUtils.html">RangeUtils</a></div></div>  </div>
 
29
</div><!--header-->
 
30
<div class="contents">
 
31
 
 
32
<p>Predicate that determines if a spectrum has a certain scan mode.  
 
33
 <a href="classOpenMS_1_1HasScanMode.html#details">More...</a></p>
 
34
 
 
35
<p><code>#include &lt;<a class="el" href="RangeUtils_8h_source.html">OpenMS/KERNEL/RangeUtils.h</a>&gt;</code></p>
 
36
<div class="dynheader">
 
37
Inheritance diagram for HasScanMode&lt; SpectrumType &gt;:</div>
 
38
<div class="dyncontent">
 
39
 <div class="center">
 
40
  <img src="classOpenMS_1_1HasScanMode.png" usemap="#HasScanMode&lt; SpectrumType &gt;_map" alt=""/>
 
41
  <map id="HasScanMode&lt; SpectrumType &gt;_map" name="HasScanMode&lt; SpectrumType &gt;_map">
 
42
</map>
 
43
 </div></div>
 
44
<table class="memberdecls">
 
45
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 
46
Public Member Functions</h2></td></tr>
 
47
<tr class="memitem:a261198ab7be4f482d8365e81898ebabc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1HasScanMode.html#a261198ab7be4f482d8365e81898ebabc">HasScanMode</a> (<a class="el" href="group__Concept.html#ga7cc214a236ad3bb6ad435bdcf5262a3f">Int</a> mode, bool reverse=false)</td></tr>
 
48
<tr class="memdesc:a261198ab7be4f482d8365e81898ebabc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a261198ab7be4f482d8365e81898ebabc">More...</a><br/></td></tr>
 
49
<tr class="separator:a261198ab7be4f482d8365e81898ebabc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
50
<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_1HasScanMode.html#a528f4cce86dd2fc219649be04f2c78ad">operator()</a> (const SpectrumType &amp;s) const </td></tr>
 
51
<tr class="separator:a528f4cce86dd2fc219649be04f2c78ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
52
</table><table class="memberdecls">
 
53
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
 
54
Protected Attributes</h2></td></tr>
 
55
<tr class="memitem:a02595a0bf6a52852eddcc5f532f15aff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#ga7cc214a236ad3bb6ad435bdcf5262a3f">Int</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1HasScanMode.html#a02595a0bf6a52852eddcc5f532f15aff">mode_</a></td></tr>
 
56
<tr class="separator:a02595a0bf6a52852eddcc5f532f15aff"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
57
<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_1HasScanMode.html#aeae704668ea77ad91c0d84485ef7677e">reverse_</a></td></tr>
 
58
<tr class="separator:aeae704668ea77ad91c0d84485ef7677e"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
59
</table>
 
60
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 
61
<div class="textblock"><h3>template&lt;class SpectrumType&gt;<br/>
 
62
class OpenMS::HasScanMode&lt; SpectrumType &gt;</h3>
 
63
 
 
64
<p>Predicate that determines if a spectrum has a certain scan mode. </p>
 
65
<p>SpectrumType must be a Spectrum or have the same interface (<a class="el" href="classOpenMS_1_1SpectrumSettings.html" title="Representation of 1D spectrum settings. ">SpectrumSettings</a>) </p>
 
66
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 
67
<a class="anchor" id="a261198ab7be4f482d8365e81898ebabc"></a>
 
68
<div class="memitem">
 
69
<div class="memproto">
 
70
<table class="mlabels">
 
71
  <tr>
 
72
  <td class="mlabels-left">
 
73
      <table class="memname">
 
74
        <tr>
 
75
          <td class="memname"><a class="el" href="classOpenMS_1_1HasScanMode.html">HasScanMode</a> </td>
 
76
          <td>(</td>
 
77
          <td class="paramtype"><a class="el" href="group__Concept.html#ga7cc214a236ad3bb6ad435bdcf5262a3f">Int</a>&#160;</td>
 
78
          <td class="paramname"><em>mode</em>, </td>
 
79
        </tr>
 
80
        <tr>
 
81
          <td class="paramkey"></td>
 
82
          <td></td>
 
83
          <td class="paramtype">bool&#160;</td>
 
84
          <td class="paramname"><em>reverse</em> = <code>false</code>&#160;</td>
 
85
        </tr>
 
86
        <tr>
 
87
          <td></td>
 
88
          <td>)</td>
 
89
          <td></td><td></td>
 
90
        </tr>
 
91
      </table>
 
92
  </td>
 
93
  <td class="mlabels-right">
 
94
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
95
  </tr>
 
96
</table>
 
97
</div><div class="memdoc">
 
98
 
 
99
<p>Constructor. </p>
 
100
<dl class="params"><dt>Parameters</dt><dd>
 
101
  <table class="params">
 
102
    <tr><td class="paramname">mode</td><td>scan mode </td></tr>
 
103
    <tr><td class="paramname">reverse</td><td>if <code>reverse</code> is true, operator() returns true if the spectrum has a different scan mode </td></tr>
 
104
  </table>
 
105
  </dd>
 
106
</dl>
 
107
 
 
108
</div>
 
109
</div>
 
110
<h2 class="groupheader">Member Function Documentation</h2>
 
111
<a class="anchor" id="a528f4cce86dd2fc219649be04f2c78ad"></a>
 
112
<div class="memitem">
 
113
<div class="memproto">
 
114
<table class="mlabels">
 
115
  <tr>
 
116
  <td class="mlabels-left">
 
117
      <table class="memname">
 
118
        <tr>
 
119
          <td class="memname">bool operator() </td>
 
120
          <td>(</td>
 
121
          <td class="paramtype">const SpectrumType &amp;&#160;</td>
 
122
          <td class="paramname"><em>s</em></td><td>)</td>
 
123
          <td> const</td>
 
124
        </tr>
 
125
      </table>
 
126
  </td>
 
127
  <td class="mlabels-right">
 
128
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 
129
  </tr>
 
130
</table>
 
131
</div><div class="memdoc">
 
132
 
 
133
<p>References <a class="el" href="classOpenMS_1_1HasScanMode.html#a02595a0bf6a52852eddcc5f532f15aff">HasScanMode&lt; SpectrumType &gt;::mode_</a>, and <a class="el" href="classOpenMS_1_1HasScanMode.html#aeae704668ea77ad91c0d84485ef7677e">HasScanMode&lt; SpectrumType &gt;::reverse_</a>.</p>
 
134
 
 
135
</div>
 
136
</div>
 
137
<h2 class="groupheader">Member Data Documentation</h2>
 
138
<a class="anchor" id="a02595a0bf6a52852eddcc5f532f15aff"></a>
 
139
<div class="memitem">
 
140
<div class="memproto">
 
141
<table class="mlabels">
 
142
  <tr>
 
143
  <td class="mlabels-left">
 
144
      <table class="memname">
 
145
        <tr>
 
146
          <td class="memname"><a class="el" href="group__Concept.html#ga7cc214a236ad3bb6ad435bdcf5262a3f">Int</a> mode_</td>
 
147
        </tr>
 
148
      </table>
 
149
  </td>
 
150
  <td class="mlabels-right">
 
151
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 
152
  </tr>
 
153
</table>
 
154
</div><div class="memdoc">
 
155
 
 
156
<p>Referenced by <a class="el" href="classOpenMS_1_1HasScanMode.html#a528f4cce86dd2fc219649be04f2c78ad">HasScanMode&lt; SpectrumType &gt;::operator()()</a>.</p>
 
157
 
 
158
</div>
 
159
</div>
 
160
<a class="anchor" id="aeae704668ea77ad91c0d84485ef7677e"></a>
 
161
<div class="memitem">
 
162
<div class="memproto">
 
163
<table class="mlabels">
 
164
  <tr>
 
165
  <td class="mlabels-left">
 
166
      <table class="memname">
 
167
        <tr>
 
168
          <td class="memname">bool reverse_</td>
 
169
        </tr>
 
170
      </table>
 
171
  </td>
 
172
  <td class="mlabels-right">
 
173
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
 
174
  </tr>
 
175
</table>
 
176
</div><div class="memdoc">
 
177
 
 
178
<p>Referenced by <a class="el" href="classOpenMS_1_1HasScanMode.html#a528f4cce86dd2fc219649be04f2c78ad">HasScanMode&lt; SpectrumType &gt;::operator()()</a>.</p>
 
179
 
 
180
</div>
 
181
</div>
 
182
</div><!-- contents -->
 
183
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
184
<TABLE width="100%" border="0">
 
185
<TR>
 
186
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
 
187
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:32 using doxygen 1.8.5</font></TD>
 
188
</TR>
 
189
</TABLE>
 
190
</BODY>
 
191
</HTML>