<!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>GG: Exception.h File Reference</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">GG
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1 -->
<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="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_a8649c70aabfef076611d3be10291d33.html">GG</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#namespaces">Namespaces</a> |
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Exception.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <<a class="el" href="Export_8h_source.html">GG/Export.h</a>></code><br/>
<code>#include <stdexcept></code><br/>
<code>#include <string></code><br/>
</div>
<p><a href="Exception_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1ExceptionBase.html">GG::ExceptionBase</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The base class for all <a class="el" href="namespaceGG.html" title="The namespace that encloses all GG classes, functions, typedefs, enums, etc.">GG</a> exceptions. <a href="classGG_1_1ExceptionBase.html#details">More...</a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceGG"><td class="memItemLeft" align="right" valign="top">namespace  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceGG.html">GG</a></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a2c6d1319984159292a38a0661aac0fc5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Exception_8h.html#a2c6d1319984159292a38a0661aac0fc5">GG_EXCEPTION</a>(name)</td></tr>
<tr class="memitem:a5f0411ffac5a6574423999f74c1a4bad"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Exception_8h.html#a5f0411ffac5a6574423999f74c1a4bad">GG_ABSTRACT_EXCEPTION</a>(name)</td></tr>
<tr class="memitem:a682a3fa1018b805ef5461feed2540863"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="Exception_8h.html#a682a3fa1018b805ef5461feed2540863">GG_CONCRETE_EXCEPTION</a>(name, class_name, superclass)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Contains the GG::Exception base class and macros that ease declaring subclasses. </p>
<p>Definition in file <a class="el" href="Exception_8h_source.html">Exception.h</a>.</p>
</div><hr/><h2>Macro Definition Documentation</h2>
<a class="anchor" id="a2c6d1319984159292a38a0661aac0fc5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GG_EXCEPTION</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">class </span>GG_API name : <span class="keyword">public</span> ExceptionBase \</div>
<div class="line"> { \</div>
<div class="line"> public: \</div>
<div class="line"> name () throw() : ExceptionBase() {} \</div>
<div class="line"> name (<span class="keyword">const</span> std::string& msg) <span class="keywordflow">throw</span>() : ExceptionBase(msg) {} \</div>
<div class="line"> virtual <span class="keyword">const</span> <span class="keywordtype">char</span>* type() <span class="keyword">const</span> throw() \</div>
<div class="line"> {<span class="keywordflow">return</span> <span class="stringliteral">"GG::"</span> # name ;} \</div>
<div class="line"> };</div>
</div><!-- fragment --><p>Declares a <a class="el" href="namespaceGG.html" title="The namespace that encloses all GG classes, functions, typedefs, enums, etc.">GG</a> exception class. This should be used to declare <a class="el" href="namespaceGG.html" title="The namespace that encloses all GG classes, functions, typedefs, enums, etc.">GG</a> exceptions at namespace scope. </p>
<p>Definition at line <a class="el" href="Exception_8h_source.html#l00061">61</a> of file <a class="el" href="Exception_8h_source.html">Exception.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5f0411ffac5a6574423999f74c1a4bad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GG_ABSTRACT_EXCEPTION</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">class </span>GG_API name : <span class="keyword">public</span> ExceptionBase \</div>
<div class="line"> { \</div>
<div class="line"> public: \</div>
<div class="line"> name () throw() : ExceptionBase() {} \</div>
<div class="line"> name (<span class="keyword">const</span> std::string& msg) <span class="keywordflow">throw</span>() : ExceptionBase(msg) {} \</div>
<div class="line"> virtual <span class="keyword">const</span> <span class="keywordtype">char</span>* type() <span class="keyword">const</span> throw() = 0; \</div>
<div class="line"> };</div>
</div><!-- fragment --><p>Declares an abstract base for further <a class="el" href="namespaceGG.html" title="The namespace that encloses all GG classes, functions, typedefs, enums, etc.">GG</a> exception class inheritance. This should be used along with GG_CONCRETE_EXCEPTION to group all exceptions from a single <a class="el" href="namespaceGG.html" title="The namespace that encloses all GG classes, functions, typedefs, enums, etc.">GG</a> class under one subhierarchy. </p>
<p>Definition at line <a class="el" href="Exception_8h_source.html#l00074">74</a> of file <a class="el" href="Exception_8h_source.html">Exception.h</a>.</p>
</div>
</div>
<a class="anchor" id="a682a3fa1018b805ef5461feed2540863"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GG_CONCRETE_EXCEPTION</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">class_name, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">superclass </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">class </span>GG_API name : <span class="keyword">public</span> superclass \</div>
<div class="line"> { \</div>
<div class="line"> public: \</div>
<div class="line"> name () throw() : superclass () {} \</div>
<div class="line"> name (<span class="keyword">const</span> std::string& msg) <span class="keywordflow">throw</span>() : superclass (msg) {} \</div>
<div class="line"> virtual <span class="keyword">const</span> <span class="keywordtype">char</span>* type() <span class="keyword">const</span> throw() \</div>
<div class="line"> {<span class="keywordflow">return</span> # class_name <span class="stringliteral">"::"</span> # name ;} \</div>
<div class="line"> };</div>
</div><!-- fragment --><p>Declares a concrete exception class derived from <em>superclass</em>. This should be used along with GG_ABSTRACT_EXCEPTION to group all exceptions from a single <a class="el" href="namespaceGG.html" title="The namespace that encloses all GG classes, functions, typedefs, enums, etc.">GG</a> class under one subhierarchy. </p>
<p>Definition at line <a class="el" href="Exception_8h_source.html#l00086">86</a> of file <a class="el" href="Exception_8h_source.html">Exception.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 15 2012 15:13:31 for GG by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1
</small></address>
</body>
</html>
