root/doc/html/itassert_8h.html @ 353

Revision 353, 15.4 kB (checked in by smidl, 16 years ago)

doc

RevLine 
[353]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: itassert.h File Reference</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li><a href="annotated.html"><span>Classes</span></a></li>
56      <li class="current"><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
62      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
63    </ul>
64  </div>
65</div>
66<div class="contents">
67<h1>itassert.h File Reference</h1>Error handling functions - header file. 
68<a href="#_details">More...</a>
69<p>
70<code>#include &lt;sstream&gt;</code><br>
71<code>#include &lt;string&gt;</code><br>
72
73<p>
74<a href="itassert_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
75<tr><td></td></tr>
76<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
77<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#gd5c34b291e5018534fd2344486e2b5a1">it_assert</a>(t, s)</td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Abort if <code>t</code> is not true.  <a href="group__errorhandlingfunc.html#gd5c34b291e5018534fd2344486e2b5a1"></a><br></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb319550e696ee9d824d23c2a176bc3a6"></a><!-- doxytag: member="itassert.h::it_assert_debug" ref="gb319550e696ee9d824d23c2a176bc3a6" args="(t, s)" -->
81#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#gb319550e696ee9d824d23c2a176bc3a6">it_assert_debug</a>(t, s)&nbsp;&nbsp;&nbsp;it_assert(t,s)</td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Abort if <code>t</code> is not true and NDEBUG is not defined. <br></td></tr>
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb2f2da10388e221de696f6ab7df51ba3"></a><!-- doxytag: member="itassert.h::it_assert0" ref="gb2f2da10388e221de696f6ab7df51ba3" args="(t, s)" -->
85#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#gb2f2da10388e221de696f6ab7df51ba3">it_assert0</a>(t, s)&nbsp;&nbsp;&nbsp;it_assert_debug(t,s)</td></tr>
86
87<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deprecated macro. Please use <code><a class="el" href="group__errorhandlingfunc.html#gb319550e696ee9d824d23c2a176bc3a6" title="Abort if t is not true and NDEBUG is not defined.">it_assert_debug()</a></code> instead. <br></td></tr>
88<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gdbf38dd073ce8b5bd14251a071477b0a"></a><!-- doxytag: member="itassert.h::it_assert1" ref="gdbf38dd073ce8b5bd14251a071477b0a" args="(t, s)" -->
89#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#gdbf38dd073ce8b5bd14251a071477b0a">it_assert1</a>(t, s)&nbsp;&nbsp;&nbsp;it_assert_debug(t,s)</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deprecated macro. Please use <code><a class="el" href="group__errorhandlingfunc.html#gb319550e696ee9d824d23c2a176bc3a6" title="Abort if t is not true and NDEBUG is not defined.">it_assert_debug()</a></code> instead. <br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#g0dfeed1c189885b05ebebe78abcc9785">it_error_if</a>(t, s)</td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Abort if <code>t</code> is true.  <a href="group__errorhandlingfunc.html#g0dfeed1c189885b05ebebe78abcc9785"></a><br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#g22d38e98332f9edff88cc501463eedce">it_error</a>(s)</td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Abort unconditionally.  <a href="group__errorhandlingfunc.html#g22d38e98332f9edff88cc501463eedce"></a><br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#g9fd46bf5a2e2228d99769b2341c18c0c">it_info</a>(s)</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print information message.  <a href="group__errorhandlingfunc.html#g9fd46bf5a2e2228d99769b2341c18c0c"></a><br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#ga5f50a438e793967af5f4ccbce0fd200">it_info_no_endl</a>(s)</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print information message withot <code>std::endl</code> at the end.  <a href="group__errorhandlingfunc.html#ga5f50a438e793967af5f4ccbce0fd200"></a><br></td></tr>
104<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga504b34ee91d002167e90daa5808963c"></a><!-- doxytag: member="itassert.h::it_info_debug" ref="ga504b34ee91d002167e90daa5808963c" args="(s)" -->
105#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#ga504b34ee91d002167e90daa5808963c">it_info_debug</a>(s)&nbsp;&nbsp;&nbsp;it_info(s)</td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print information message if NDEBUG is not defined. <br></td></tr>
108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb6ec26d80721b2990fd0ca0393daf430"></a><!-- doxytag: member="itassert.h::it_info_no_endl_debug" ref="gb6ec26d80721b2990fd0ca0393daf430" args="(s)" -->
109#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#gb6ec26d80721b2990fd0ca0393daf430">it_info_no_endl_debug</a>(s)&nbsp;&nbsp;&nbsp;it_info_no_endl(s)</td></tr>
110
111<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print information message withot <code>std::endl</code> at the end if NDEBUG is not defined. <br></td></tr>
112<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#g365842195965b61b7ab3ac7938c58b77">it_warning</a>(s)</td></tr>
113
114<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Display a warning message.  <a href="group__errorhandlingfunc.html#g365842195965b61b7ab3ac7938c58b77"></a><br></td></tr>
115<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
116<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#g240f2880b00be0707d042f2ce94c60eb">itpp::error_msg_style</a> { <b>Full</b>,
117<b>Minimum</b>
118 }</td></tr>
119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Style of assert, error and warning messages. <br></td></tr>
121<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
122<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge75ba7a501dbe8083fc9569df545bfbf"></a><!-- doxytag: member="itassert.h::it_assert_f" ref="ge75ba7a501dbe8083fc9569df545bfbf" args="(std::string ass, std::string msg, std::string file, int line)" -->
123void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#ge75ba7a501dbe8083fc9569df545bfbf">itpp::it_assert_f</a> (std::string ass, std::string msg, std::string file, int line)</td></tr>
124
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Helper function for the <code>it_assert</code> and <code>it_assert_debug</code> macros. <br></td></tr>
126<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6433649664140b535c257b7e676d6802"></a><!-- doxytag: member="itassert.h::it_error_f" ref="g6433649664140b535c257b7e676d6802" args="(std::string msg, std::string file, int line)" -->
127void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#g6433649664140b535c257b7e676d6802">itpp::it_error_f</a> (std::string msg, std::string file, int line)</td></tr>
128
129<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Helper function for the <code>it_error</code> and <code>it_error_if</code> macros. <br></td></tr>
130<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3918817375e27902994abcd4a7dcd0b0"></a><!-- doxytag: member="itassert.h::it_info_f" ref="g3918817375e27902994abcd4a7dcd0b0" args="(std::string msg)" -->
131void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#g3918817375e27902994abcd4a7dcd0b0">itpp::it_info_f</a> (std::string msg)</td></tr>
132
133<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Helper function for the <code>it_info</code> and <code>it_info_debug</code> macros. <br></td></tr>
134<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf7cd873ef7191dbdae7f34d635b2b336"></a><!-- doxytag: member="itassert.h::it_warning_f" ref="gf7cd873ef7191dbdae7f34d635b2b336" args="(std::string msg, std::string file, int line)" -->
135void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#gf7cd873ef7191dbdae7f34d635b2b336">itpp::it_warning_f</a> (std::string msg, std::string file, int line)</td></tr>
136
137<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Helper function for the <code>it_warning</code> macro. <br></td></tr>
138<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gbfeae66baa360366476a1cbff5bd9a55"></a><!-- doxytag: member="itassert.h::it_enable_exceptions" ref="gbfeae66baa360366476a1cbff5bd9a55" args="(bool on)" -->
139void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#gbfeae66baa360366476a1cbff5bd9a55">itpp::it_enable_exceptions</a> (bool on)</td></tr>
140
141<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enable/disable using exceptions for error handling. <br></td></tr>
142<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge6044970b0d1826008f4bd9126cdfbff"></a><!-- doxytag: member="itassert.h::it_enable_warnings" ref="ge6044970b0d1826008f4bd9126cdfbff" args="()" -->
143void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#ge6044970b0d1826008f4bd9126cdfbff">itpp::it_enable_warnings</a> ()</td></tr>
144
145<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enable warnings. <br></td></tr>
146<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb62a8f63f3fe7247b80ea6bd298c868f"></a><!-- doxytag: member="itassert.h::it_disable_warnings" ref="gb62a8f63f3fe7247b80ea6bd298c868f" args="()" -->
147void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#gb62a8f63f3fe7247b80ea6bd298c868f">itpp::it_disable_warnings</a> ()</td></tr>
148
149<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Disable warnings. <br></td></tr>
150<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf735d09367b95f954d99462845f9b878"></a><!-- doxytag: member="itassert.h::it_redirect_warnings" ref="gf735d09367b95f954d99462845f9b878" args="(std::ostream *warn_stream)" -->
151void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#gf735d09367b95f954d99462845f9b878">itpp::it_redirect_warnings</a> (std::ostream *warn_stream)</td></tr>
152
153<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Redirect warnings to the ostream warn_stream. <br></td></tr>
154<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g570195341cb1731c69519f556ad8de8b"></a><!-- doxytag: member="itassert.h::it_error_msg_style" ref="g570195341cb1731c69519f556ad8de8b" args="(error_msg_style style)" -->
155void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__errorhandlingfunc.html#g570195341cb1731c69519f556ad8de8b">itpp::it_error_msg_style</a> (error_msg_style style)</td></tr>
156
157<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set preferred style of assert, error and warning messages. <br></td></tr>
158</table>
159<hr><a name="_details"></a><h2>Detailed Description</h2>
160Error handling functions - header file.
161<p>
162<dl class="author" compact><dt><b>Author:</b></dt><dd>Tobias Ringstrom and Adam Piatyszek</dd></dl>
163-------------------------------------------------------------------------<p>
164Copyright (C) 1995-2008 (see AUTHORS file for a list of contributors)<p>
165This file is part of IT++ - a C++ library of mathematical, signal processing, speech processing, and communications classes and functions.<p>
166IT++ is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.<p>
167IT++ is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.<p>
168You should have received a copy of the GNU General Public License along with IT++. If not, see &lt;<a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.<p>
169------------------------------------------------------------------------- </div>
170<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:13 2009 for mixpp by&nbsp;
171<a href="http://www.doxygen.org/index.html">
172<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
173</body>
174</html>
Note: See TracBrowser for help on using the browser.