<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>CVC3: exception.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">CVC3 <span id="projectnumber">2.4.1</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">exception.h</div> </div>
</div>
<div class="contents">
<a href="exception_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*****************************************************************************/</span><span class="comment"></span>
<a name="l00002"></a>00002 <span class="comment">/*!</span>
<a name="l00003"></a>00003 <span class="comment"> * \file exception.h</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * Author: Sergey Berezin</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * Created: Thu Feb 6 13:09:44 2003</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * <hr></span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * License to use, copy, modify, sell and/or distribute this software</span>
<a name="l00012"></a>00012 <span class="comment"> * and its documentation for any purpose is hereby granted without</span>
<a name="l00013"></a>00013 <span class="comment"> * royalty, subject to the terms and conditions defined in the \ref</span>
<a name="l00014"></a>00014 <span class="comment"> * LICENSE file provided with this distribution.</span>
<a name="l00015"></a>00015 <span class="comment"> * </span>
<a name="l00016"></a>00016 <span class="comment"> * <hr></span>
<a name="l00017"></a>00017 <span class="comment"> * </span>
<a name="l00018"></a>00018 <span class="comment"> * A generic exception. Any thrown exception must inherit from this</span>
<a name="l00019"></a>00019 <span class="comment"> * class and whenever possible, set the error message.</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021 <span class="comment">/*****************************************************************************/</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef _cvc3__exception_h_</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define _cvc3__exception_h_</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <string></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <iostream></span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">namespace </span>CVC3 {
<a name="l00030"></a>00030
<a name="l00031"></a><a class="code" href="classCVC3_1_1Exception.html">00031</a> <span class="keyword">class </span><a class="code" href="classCVC3_1_1Exception.html">Exception</a> {
<a name="l00032"></a>00032 <span class="keyword">protected</span>:
<a name="l00033"></a><a class="code" href="classCVC3_1_1Exception.html#ae4c896c4f9db2cded61761aace45b397">00033</a> std::string <a class="code" href="classCVC3_1_1Exception.html#ae4c896c4f9db2cded61761aace45b397">d_msg</a>;
<a name="l00034"></a>00034 <span class="keyword">public</span>:
<a name="l00035"></a>00035 <span class="comment">// Constructors</span>
<a name="l00036"></a><a class="code" href="classCVC3_1_1Exception.html#abc21464834c8a8d18063b7a3685f773c">00036</a> <a class="code" href="classCVC3_1_1Exception.html#abc21464834c8a8d18063b7a3685f773c">Exception</a>(): <a class="code" href="classCVC3_1_1Exception.html#ae4c896c4f9db2cded61761aace45b397">d_msg</a>(<span class="stringliteral">"Unknown exception"</span>) { }
<a name="l00037"></a><a class="code" href="classCVC3_1_1Exception.html#aef5837709932c85ebf1ba12f9c7199a4">00037</a> <a class="code" href="classCVC3_1_1Exception.html#aef5837709932c85ebf1ba12f9c7199a4">Exception</a>(<span class="keyword">const</span> std::string& msg): <a class="code" href="classCVC3_1_1Exception.html#ae4c896c4f9db2cded61761aace45b397">d_msg</a>(msg) { }
<a name="l00038"></a><a class="code" href="classCVC3_1_1Exception.html#a0e9a2298ddb0fad47978db6afc20bc39">00038</a> <a class="code" href="classCVC3_1_1Exception.html#a0e9a2298ddb0fad47978db6afc20bc39">Exception</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* msg): <a class="code" href="classCVC3_1_1Exception.html#ae4c896c4f9db2cded61761aace45b397">d_msg</a>(msg) { }
<a name="l00039"></a>00039 <span class="comment">// Destructor</span>
<a name="l00040"></a><a class="code" href="classCVC3_1_1Exception.html#a89e771d00260a52ee47aba0a956cbed4">00040</a> <span class="keyword">virtual</span> <a class="code" href="classCVC3_1_1Exception.html#a89e771d00260a52ee47aba0a956cbed4">~Exception</a>() { }
<a name="l00041"></a>00041 <span class="comment">// NON-VIRTUAL METHODs for setting and printing the error message</span>
<a name="l00042"></a><a class="code" href="classCVC3_1_1Exception.html#a972edd1235fdc8cc9cc421e15c72b0d3">00042</a> <span class="keywordtype">void</span> <a class="code" href="classCVC3_1_1Exception.html#a972edd1235fdc8cc9cc421e15c72b0d3">setMessage</a>(<span class="keyword">const</span> std::string& msg) { <a class="code" href="classCVC3_1_1Exception.html#ae4c896c4f9db2cded61761aace45b397">d_msg</a> = msg; }
<a name="l00043"></a>00043 <span class="comment">// Printing: feel free to redefine toString(). When inherited,</span>
<a name="l00044"></a>00044 <span class="comment">// it's recommended that this method print the type of exception</span>
<a name="l00045"></a>00045 <span class="comment">// before the actual message.</span>
<a name="l00046"></a><a class="code" href="classCVC3_1_1Exception.html#a1c8a5ddbb45b98059454efc839394f96">00046</a> <span class="keyword">virtual</span> std::string <a class="code" href="classCVC3_1_1Exception.html#a1c8a5ddbb45b98059454efc839394f96">toString</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="classCVC3_1_1Exception.html#ae4c896c4f9db2cded61761aace45b397">d_msg</a>; }
<a name="l00047"></a>00047 <span class="comment">// No need to overload operator<< for the inherited classes</span>
<a name="l00048"></a>00048 <span class="keyword">friend</span> std::ostream& <a class="code" href="classCVC3_1_1Exception.html#a71385e852018ec00029282d01881c4eb">operator<<</a>(std::ostream& os, <span class="keyword">const</span> <a class="code" href="classCVC3_1_1Exception.html">Exception</a>& e);
<a name="l00049"></a>00049
<a name="l00050"></a>00050 }; <span class="comment">// end of class Exception</span>
<a name="l00051"></a>00051
<a name="l00052"></a><a class="code" href="namespaceCVC3.html#a0ec996f2024ac08fe87e72b066425be1">00052</a> <span class="keyword">inline</span> std::ostream& <a class="code" href="namespaceCVC3.html#a6b7e38d3c97da1e91e12a6c9555b8163">operator<<</a>(std::ostream& os, <span class="keyword">const</span> <a class="code" href="classCVC3_1_1Exception.html">Exception</a>& e) {
<a name="l00053"></a>00053 <span class="keywordflow">return</span> os << e.<a class="code" href="classCVC3_1_1Exception.html#a1c8a5ddbb45b98059454efc839394f96">toString</a>();
<a name="l00054"></a>00054 }
<a name="l00055"></a>00055
<a name="l00056"></a>00056 } <span class="comment">// end of namespace CVC3 </span>
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Sep 7 2011 for CVC3 by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
