File: group__Conditions.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 (112 lines) | stat: -rw-r--r-- 10,187 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
<HTML>
<HEAD>
<TITLE>Condition macros</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><!-- top -->
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a>  </div>
  <div class="headertitle">
<div class="title">Condition macros<div class="ingroups"><a class="el" href="group__Concept.html">Concept</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Macros used for to enforce preconditions and postconditions.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga45a74ea28109e7e1ed992fbd2ee97778"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Conditions.html#ga45a74ea28109e7e1ed992fbd2ee97778">OPENMS_PRECONDITION</a>(condition, message)</td></tr>
<tr class="memdesc:ga45a74ea28109e7e1ed992fbd2ee97778"><td class="mdescLeft">&#160;</td><td class="mdescRight">Precondition macro.  <a href="#ga45a74ea28109e7e1ed992fbd2ee97778">More...</a><br/></td></tr>
<tr class="separator:ga45a74ea28109e7e1ed992fbd2ee97778"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad781993fbeead99f7a76a5b0c67b70e1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Conditions.html#gad781993fbeead99f7a76a5b0c67b70e1">OPENMS_POSTCONDITION</a>(condition, message)</td></tr>
<tr class="memdesc:gad781993fbeead99f7a76a5b0c67b70e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Postcondition macro.  <a href="#gad781993fbeead99f7a76a5b0c67b70e1">More...</a><br/></td></tr>
<tr class="separator:gad781993fbeead99f7a76a5b0c67b70e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Macros used for to enforce preconditions and postconditions. </p>
<p>These macros are enabled if debug info is enabled and optimization is disabled in configure. Otherwise they are replaced by an empty string, so they won't cost any performance.</p>
<p>The macros throw Exception::Precondition or Exception::Postcondition respectively if the condition fails. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gad781993fbeead99f7a76a5b0c67b70e1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define OPENMS_POSTCONDITION</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">condition, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">message&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Postcondition macro. </p>

<p>Referenced by <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmPicked.html#a5ae84d207afd136419c46d9ec811bb97">FeatureFinderAlgorithmPicked&lt; PeakType, FeatureType &gt;::intensityScore_()</a>, and <a class="el" href="classOpenMS_1_1FeatureFinderAlgorithmPicked.html#a55abad1b592c5e19bfaddfc9f9c4a43e">FeatureFinderAlgorithmPicked&lt; PeakType, FeatureType &gt;::isotopeScore_()</a>.</p>

</div>
</div>
<a class="anchor" id="ga45a74ea28109e7e1ed992fbd2ee97778"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define OPENMS_PRECONDITION</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">condition, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">message&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Precondition macro. </p>

<p>Referenced by <a class="el" href="classOpenMS_1_1MSExperiment.html#aa23ed32415e6667bd2737377c24c16fb">MSExperiment&lt; SimPointType &gt;::areaBeginConst()</a>, <a class="el" href="classOpenMS_1_1EmgScoring.html#a91a12a6c61f55d0f433b2630f1d0fd9a">EmgScoring::calcElutionFitScore()</a>, <a class="el" href="classOpenMS_1_1SimpleExtender.html#a8597c0a5982f48f9a8387e286b0251b0">SimpleExtender&lt; PeakType, FeatureType &gt;::checkNeighbour_()</a>, <a class="el" href="classOpenMS_1_1Internal_1_1XMLHandler.html#ab42b06789e80b05f0b754201cb1deccc">XMLHandler::cvStringToEnum_()</a>, <a class="el" href="classOpenMS_1_1DPosition.html#a5b75d524290b67c39818f882a077f424">DPosition&lt; DIMENSION &gt;::DPosition()</a>, <a class="el" href="classOpenMS_1_1DRange.html#aa0119e148d758188177d21ffb87be6c2">DRange&lt; 3 &gt;::DRange()</a>, <a class="el" href="classOpenMS_1_1SimpleExtender.html#a1139a06b7cf1886d1977e5afcfddfea6">SimpleExtender&lt; PeakType, FeatureType &gt;::extend()</a>, <a class="el" href="classOpenMS_1_1SpectrumCanvas.html#a26a80b5223580d2fba3fe15058eb5ae3">SpectrumCanvas::getCurrentLayer()</a>, <a class="el" href="structOpenMS_1_1PeakIndex.html#a7964d7f08b6732699e3e86111f185649">PeakIndex::getFeature()</a>, <a class="el" href="classOpenMS_1_1SpectrumCanvas.html#adfc6ea9e012a14143cb30eeb58add8e5">SpectrumCanvas::getLayer()</a>, <a class="el" href="classOpenMS_1_1SpectrumCanvas.html#a9b5e0badc51d4af84eb6a0919dd0adbb">SpectrumCanvas::getLayer_()</a>, <a class="el" href="classOpenMS_1_1SpectrumCanvas.html#a371bb924999fcac19fe7bfe28a1c8dd0">SpectrumCanvas::getLayerFlag()</a>, <a class="el" href="classOpenMS_1_1ProductModel_3_012_01_4.html#a5a40666cbd449e6dab1270ef7153f490">ProductModel&lt; 2 &gt;::getModel()</a>, <a class="el" href="classOpenMS_1_1FeaFiModule.html#a9f755c03fd9b7a485fec02224cc858d7">FeaFiModule&lt; PeakType, FeatureType &gt;::getNextMz()</a>, <a class="el" href="classOpenMS_1_1FeaFiModule.html#adf52c00b457571ad74d59a5d6fd12d1a">FeaFiModule&lt; PeakType, FeatureType &gt;::getNextRt()</a>, <a class="el" href="structOpenMS_1_1PeakIndex.html#a7fc5292f4ba9ca9642d565c0bc52f5af">PeakIndex::getPeak()</a>, <a class="el" href="classOpenMS_1_1FeaFiModule.html#a4698fa90bfbdd5729e0e25c62345ff0d">FeaFiModule&lt; PeakType, FeatureType &gt;::getPeakIntensity()</a>, <a class="el" href="classOpenMS_1_1FeaFiModule.html#a606049d47faacd506705556d333849a2">FeaFiModule&lt; PeakType, FeatureType &gt;::getPeakMz()</a>, <a class="el" href="classOpenMS_1_1FeaFiModule.html#a8e5564d7b686645a7d7d6f5aed8cd494">FeaFiModule&lt; PeakType, FeatureType &gt;::getPeakRt()</a>, <a class="el" href="classOpenMS_1_1FeaFiModule.html#a62c6d0208b4fc2bc51e55eea8ea1ce9d">FeaFiModule&lt; PeakType, FeatureType &gt;::getPrevMz()</a>, <a class="el" href="classOpenMS_1_1FeaFiModule.html#ad4efb644d8a117edfaf7f0f5a9b34e0a">FeaFiModule&lt; PeakType, FeatureType &gt;::getPrevRt()</a>, <a class="el" href="structOpenMS_1_1PeakIndex.html#ae1302e8c1dc9de4b726ea79347bf2dd9">PeakIndex::getSpectrum()</a>, <a class="el" href="classOpenMS_1_1DPosition.html#a98f4c6eb6bb88b8618c1bd62d2a555ff">DPosition&lt; DIMENSION &gt;::getX()</a>, <a class="el" href="classOpenMS_1_1DPosition.html#ae436a73cd6962ada8a89aee967fd581e">DPosition&lt; DIMENSION &gt;::getY()</a>, <a class="el" href="classOpenMS_1_1SimpleExtender.html#af560e97f4f00d467116a5791bcdf7ca5">SimpleExtender&lt; PeakType, FeatureType &gt;::isTooFarFromCentroid_()</a>, <a class="el" href="classOpenMS_1_1OfflinePrecursorIonSelection.html#afc3ec85793adf0cdaacc5803e59f6c17">OfflinePrecursorIonSelection::makePrecursorSelectionForKnownLCMSMap()</a>, <a class="el" href="classOpenMS_1_1Matrix.html#afd5c336c2c77a7827dc01757e90010f9">Matrix&lt; unsigned int &gt;::operator&lt;()</a>, <a class="el" href="classOpenMS_1_1Matrix.html#ade79bea45fa446d17e5f6d0c4ca0572b">Matrix&lt; unsigned int &gt;::operator==()</a>, <a class="el" href="classOpenMS_1_1DistanceMatrix.html#a1d0873881e7b88b2775fdf10cabf868c">DistanceMatrix&lt; Value &gt;::operator==()</a>, <a class="el" href="classOpenMS_1_1DPosition.html#ab402dba8635ea0cf7e7179af806bc2d6">DPosition&lt; DIMENSION &gt;::operator[]()</a>, <a class="el" href="classOpenMS_1_1MultiGradient.html#a155a7c2cce8c5dd078d75b7e7bad0b57">MultiGradient::precalculatedColorByIndex()</a>, <a class="el" href="classOpenMS_1_1MultiGradient.html#aa7b0b32d0a3b6e619f396df53041aaec">MultiGradient::precalculatedColorIndex()</a>, <a class="el" href="classOpenMS_1_1SpectrumCanvas.html#aa9f0f149907e02e947cf0af5a4bc7836">SpectrumCanvas::setLabel()</a>, <a class="el" href="classOpenMS_1_1SpectrumCanvas.html#a8688e002a6cde0ff679ae74a4e31c4ae">SpectrumCanvas::setLayerFlag()</a>, <a class="el" href="classOpenMS_1_1ProductModel_3_012_01_4.html#a8cd14764d47842020930ef7023a2d912">ProductModel&lt; 2 &gt;::setModel()</a>, <a class="el" href="classOpenMS_1_1DPosition.html#a7682888cd6f2b9f849548fb952307011">DPosition&lt; DIMENSION &gt;::setX()</a>, and <a class="el" href="classOpenMS_1_1DPosition.html#af9bb559c966c59f89d73b704d05592ad">DPosition&lt; DIMENSION &gt;::setY()</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:25 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>