<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>CVC3: exception.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">CVC3
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b0856f6b0d80ccb263b2f415c91f9e17.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">exception.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="exception_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*****************************************************************************/</span><span class="comment"></span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*!</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * \file exception.h</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Author: Sergey Berezin</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Created: Thu Feb 6 13:09:44 2003</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * <hr></span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * License to use, copy, modify, sell and/or distribute this software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * and its documentation for any purpose is hereby granted without</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * royalty, subject to the terms and conditions defined in the \ref</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * LICENSE file provided with this distribution.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * <hr></span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * A generic exception. Any thrown exception must inherit from this</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * class and whenever possible, set the error message.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">/*****************************************************************************/</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef _cvc3__exception_h_</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span><span class="preprocessor">#define _cvc3__exception_h_</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <iostream></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span>CVC3 {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="code" href="classCVC3_1_1Exception.html"> 31</a></span>  <span class="keyword">class </span><a class="code" href="classCVC3_1_1Exception.html">Exception</a> {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="code" href="classCVC3_1_1Exception.html#ae4c896c4f9db2cded61761aace45b397"> 33</a></span>  std::string <a class="code" href="classCVC3_1_1Exception.html#ae4c896c4f9db2cded61761aace45b397">d_msg</a>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="comment">// Constructors</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="code" href="classCVC3_1_1Exception.html#abc21464834c8a8d18063b7a3685f773c"> 36</a></span>  <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>) { }</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="code" href="classCVC3_1_1Exception.html#aef5837709932c85ebf1ba12f9c7199a4"> 37</a></span>  <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) { }</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="code" href="classCVC3_1_1Exception.html#a0e9a2298ddb0fad47978db6afc20bc39"> 38</a></span>  <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) { }</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="comment">// Destructor</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="code" href="classCVC3_1_1Exception.html#a89e771d00260a52ee47aba0a956cbed4"> 40</a></span>  <span class="keyword">virtual</span> <a class="code" href="classCVC3_1_1Exception.html#a89e771d00260a52ee47aba0a956cbed4">~Exception</a>() { }</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// NON-VIRTUAL METHODs for setting and printing the error message</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="code" href="classCVC3_1_1Exception.html#a972edd1235fdc8cc9cc421e15c72b0d3"> 42</a></span>  <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; }</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">// Printing: feel free to redefine toString(). When inherited,</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="comment">// it's recommended that this method print the type of exception</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">// before the actual message.</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="code" href="classCVC3_1_1Exception.html#a1c8a5ddbb45b98059454efc839394f96"> 46</a></span>  <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>; }</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">// No need to overload operator<< for the inherited classes</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <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);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  }; <span class="comment">// end of class Exception</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="code" href="namespaceCVC3.html#a0ec996f2024ac08fe87e72b066425be1"> 52</a></span>  <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) {</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">return</span> os << e.<a class="code" href="classCVC3_1_1Exception.html#a1c8a5ddbb45b98059454efc839394f96">toString</a>();</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  }</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> } <span class="comment">// end of namespace CVC3 </span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 16 2013 13:25:13 for CVC3 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.2
</small></address>
</body>
</html>
