mirror of
https://github.com/libAthena/athena.git
synced 2025-08-27 05:55:49 +00:00
280 lines
16 KiB
HTML
280 lines
16 KiB
HTML
<!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"/>
|
|
<meta name="generator" content="Doxygen 1.8.9.1"/>
|
|
<title>Athena IO Library: Athena::error::Exception Class 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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</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">Athena IO Library
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.9.1 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('class_athena_1_1error_1_1_exception.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="class_athena_1_1error_1_1_exception-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Athena::error::Exception Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>The baseclass for all Exceptions.
|
|
<a href="class_athena_1_1error_1_1_exception.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_exception_8hpp_source.html">Exception.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for Athena::error::Exception:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_athena_1_1error_1_1_exception__inherit__graph.png" border="0" usemap="#_athena_1_1error_1_1_exception_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="_athena_1_1error_1_1_exception_inherit__map" id="_athena_1_1error_1_1_exception_inherit__map">
|
|
<area shape="rect" id="node2" href="class_athena_1_1error_1_1_file_not_found_exception.html" title="An excpeption thrown when a file could not be found at the given path. " alt="" coords="5,263,212,369"/><area shape="rect" id="node3" href="class_athena_1_1error_1_1_invalid_data_exception.html" title="An exception thrown on Invalid Data calls. " alt="" coords="237,270,431,362"/><area shape="rect" id="node4" href="class_athena_1_1error_1_1_invalid_operation_exception.html" title="An excpeption thrown on Invalid Operations calls. " alt="" coords="455,270,682,362"/><area shape="rect" id="node5" href="class_athena_1_1error_1_1_i_o_exception.html" title="An excpeption thrown on inappropriate IO calls. " alt="" coords="707,277,905,355"/><area shape="rect" id="node6" href="class_athena_1_1error_1_1_not_implemented_exception.html" title="{Athena::error::NotImplemented\lException\n||+ NotImplementedException()\l}" alt="" coords="930,270,1159,362"/></map>
|
|
</div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for Athena::error::Exception:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_athena_1_1error_1_1_exception__coll__graph.png" border="0" usemap="#_athena_1_1error_1_1_exception_coll__map" alt="Collaboration graph"/></div>
|
|
</div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a6d3d8ea6244f6c31e5e8fde78acb891e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_athena_1_1error_1_1_exception.html#a6d3d8ea6244f6c31e5e8fde78acb891e">Exception</a> (const std::string &<a class="el" href="class_athena_1_1error_1_1_exception.html#a01898523fb445712bd95b2404b9baa66">message</a>, const std::string &file, const std::string &function, const int line)</td></tr>
|
|
<tr class="memdesc:a6d3d8ea6244f6c31e5e8fde78acb891e"><td class="mdescLeft"> </td><td class="mdescRight">The constructor for an <a class="el" href="class_athena_1_1error_1_1_exception.html" title="The baseclass for all Exceptions. ">Exception</a>. <a href="#a6d3d8ea6244f6c31e5e8fde78acb891e">More...</a><br /></td></tr>
|
|
<tr class="separator:a6d3d8ea6244f6c31e5e8fde78acb891e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a01898523fb445712bd95b2404b9baa66"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_athena_1_1error_1_1_exception.html#a01898523fb445712bd95b2404b9baa66">message</a> () const </td></tr>
|
|
<tr class="memdesc:a01898523fb445712bd95b2404b9baa66"><td class="mdescLeft"> </td><td class="mdescRight">Returns the Error message of the exception. <a href="#a01898523fb445712bd95b2404b9baa66">More...</a><br /></td></tr>
|
|
<tr class="separator:a01898523fb445712bd95b2404b9baa66"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa0922bd9fdf67ddf2eb538f5624e0e7d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa0922bd9fdf67ddf2eb538f5624e0e7d"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><b>file</b> () const </td></tr>
|
|
<tr class="separator:aa0922bd9fdf67ddf2eb538f5624e0e7d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2f0ded5973f82f5d1626944ffabe1f35"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f0ded5973f82f5d1626944ffabe1f35"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><b>function</b> () const </td></tr>
|
|
<tr class="separator:a2f0ded5973f82f5d1626944ffabe1f35"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aad85f56b203861b9c9a4c850cf638b01"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad85f56b203861b9c9a4c850cf638b01"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>line</b> () const </td></tr>
|
|
<tr class="separator:aad85f56b203861b9c9a4c850cf638b01"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afffd26ca88d4c37f456176f36fcf521d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afffd26ca88d4c37f456176f36fcf521d"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><b>formattedMessage</b> () const </td></tr>
|
|
<tr class="separator:afffd26ca88d4c37f456176f36fcf521d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:a5a6ccea051c659632f5b2750f64e55f2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5a6ccea051c659632f5b2750f64e55f2"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_athena_1_1error_1_1_exception.html#a5a6ccea051c659632f5b2750f64e55f2">m_message</a></td></tr>
|
|
<tr class="memdesc:a5a6ccea051c659632f5b2750f64e55f2"><td class="mdescLeft"> </td><td class="mdescRight">The error message string. <br /></td></tr>
|
|
<tr class="separator:a5a6ccea051c659632f5b2750f64e55f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a51ce681cd8fa07ffa0ca14bb4ad0d0fb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a51ce681cd8fa07ffa0ca14bb4ad0d0fb"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><b>m_file</b></td></tr>
|
|
<tr class="separator:a51ce681cd8fa07ffa0ca14bb4ad0d0fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3c8fdb14e98eba5166b4c67ea538055b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c8fdb14e98eba5166b4c67ea538055b"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><b>m_function</b></td></tr>
|
|
<tr class="separator:a3c8fdb14e98eba5166b4c67ea538055b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad6bce8685d7eb18c7f9decc634d56a7d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad6bce8685d7eb18c7f9decc634d56a7d"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>m_line</b></td></tr>
|
|
<tr class="separator:ad6bce8685d7eb18c7f9decc634d56a7d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad12d37031fd388584cbb45a09c42424f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad12d37031fd388584cbb45a09c42424f"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><b>m_exceptionName</b></td></tr>
|
|
<tr class="separator:ad12d37031fd388584cbb45a09c42424f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>The baseclass for all Exceptions. </p>
|
|
<p><b>Do Not</b> use <a class="el" href="class_athena_1_1error_1_1_exception.html" title="The baseclass for all Exceptions. ">Exception</a> directly, instead create an appropriate <a class="el" href="class_athena_1_1error_1_1_exception.html" title="The baseclass for all Exceptions. ">Exception</a> class and inherit from this baseclass. </p>
|
|
|
|
<p>Definition at line <a class="el" href="_exception_8hpp_source.html#l00038">38</a> of file <a class="el" href="_exception_8hpp_source.html">Exception.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a6d3d8ea6244f6c31e5e8fde78acb891e"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Athena::error::Exception::Exception </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>message</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>file</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>function</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>line</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The constructor for an <a class="el" href="class_athena_1_1error_1_1_exception.html" title="The baseclass for all Exceptions. ">Exception</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">message</td><td>The error message to throw </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="_exception_8hpp_source.html#l00044">44</a> of file <a class="el" href="_exception_8hpp_source.html">Exception.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a01898523fb445712bd95b2404b9baa66"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string Athena::error::Exception::message </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the Error message of the exception. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>std::string The error message </dd></dl>
|
|
|
|
<p>Definition at line <a class="el" href="_exception_8hpp_source.html#l00056">56</a> of file <a class="el" href="_exception_8hpp_source.html">Exception.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>include/Athena/<a class="el" href="_exception_8hpp_source.html">Exception.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><b>Athena</b></li><li class="navelem"><b>error</b></li><li class="navelem"><a class="el" href="class_athena_1_1error_1_1_exception.html">Exception</a></li>
|
|
<li class="footer">Generated on Thu May 21 2015 01:59:40 for Athena IO Library by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|