Files
GridFire/docs/html/classgridfire_1_1exceptions_1_1ReactionError.html

262 lines
13 KiB
HTML
Raw Normal View History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GridFire: gridfire::exceptions::ReactionError 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>
<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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.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 id="projectrow">
<td id="projectalign">
<div id="projectname">GridFire<span id="projectnumber">&#160;v0.7.1_rc2</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classgridfire_1_1exceptions_1_1ReactionError.html',''); initResizable(); });
/* @license-end */
</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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classgridfire_1_1exceptions_1_1ReactionError-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">gridfire::exceptions::ReactionError Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Base class for all exceptions related to reaction operations.
<a href="classgridfire_1_1exceptions_1_1ReactionError.html#details">More...</a></p>
<p><code>#include &lt;error_reaction.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for gridfire::exceptions::ReactionError:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1exceptions_1_1ReactionError__inherit__graph.svg" width="176" height="300"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for gridfire::exceptions::ReactionError:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1exceptions_1_1ReactionError__coll__graph.svg" width="275" height="318"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a51a26442fb905643a6d871ab733f0ab5" id="r_a51a26442fb905643a6d871ab733f0ab5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1exceptions_1_1ReactionError.html#a51a26442fb905643a6d871ab733f0ab5">ReactionError</a> (const std::string &amp;msg, const std::string &amp;reactionId)</td></tr>
<tr class="separator:a51a26442fb905643a6d871ab733f0ab5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7bc47cdb02c2f8a803306cb9bb75b1af" id="r_a7bc47cdb02c2f8a803306cb9bb75b1af"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1exceptions_1_1ReactionError.html#a7bc47cdb02c2f8a803306cb9bb75b1af">what</a> () const noexcept override</td></tr>
<tr class="separator:a7bc47cdb02c2f8a803306cb9bb75b1af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgridfire_1_1exceptions_1_1GridFireError"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgridfire_1_1exceptions_1_1GridFireError')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgridfire_1_1exceptions_1_1GridFireError.html">gridfire::exceptions::GridFireError</a></td></tr>
<tr class="memitem:a672d340ff9287f5511342a4e5f4fbb23 inherit pub_methods_classgridfire_1_1exceptions_1_1GridFireError" id="r_a672d340ff9287f5511342a4e5f4fbb23"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1exceptions_1_1GridFireError.html#a672d340ff9287f5511342a4e5f4fbb23">GridFireError</a> (std::string msg)</td></tr>
<tr class="separator:a672d340ff9287f5511342a4e5f4fbb23 inherit pub_methods_classgridfire_1_1exceptions_1_1GridFireError"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6986522d45e8d94da310d1b37373414c inherit pub_methods_classgridfire_1_1exceptions_1_1GridFireError" id="r_a6986522d45e8d94da310d1b37373414c"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1exceptions_1_1GridFireError.html#a6986522d45e8d94da310d1b37373414c">what</a> () const noexcept override</td></tr>
<tr class="separator:a6986522d45e8d94da310d1b37373414c inherit pub_methods_classgridfire_1_1exceptions_1_1GridFireError"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a980c78dbdeac44fd3eec976221799647" id="r_a980c78dbdeac44fd3eec976221799647"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1exceptions_1_1ReactionError.html#a980c78dbdeac44fd3eec976221799647">m_message</a></td></tr>
<tr class="separator:a980c78dbdeac44fd3eec976221799647"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3531af904d90838ac856cf72cb555f8" id="r_ae3531af904d90838ac856cf72cb555f8"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1exceptions_1_1ReactionError.html#ae3531af904d90838ac856cf72cb555f8">m_reactionID</a></td></tr>
<tr class="separator:ae3531af904d90838ac856cf72cb555f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class for all exceptions related to reaction operations. </p>
<p>This exception is the parent for more specific reaction-related errors. Catching this type will catch any exception originating from reaction handling. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a51a26442fb905643a6d871ab733f0ab5" name="a51a26442fb905643a6d871ab733f0ab5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51a26442fb905643a6d871ab733f0ab5">&#9670;&#160;</a></span>ReactionError()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gridfire::exceptions::ReactionError::ReactionError </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>reactionId</em>&#160;</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">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7bc47cdb02c2f8a803306cb9bb75b1af" name="a7bc47cdb02c2f8a803306cb9bb75b1af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bc47cdb02c2f8a803306cb9bb75b1af">&#9670;&#160;</a></span>what()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const char * gridfire::exceptions::ReactionError::what </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 class="mlabel">override</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a980c78dbdeac44fd3eec976221799647" name="a980c78dbdeac44fd3eec976221799647"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a980c78dbdeac44fd3eec976221799647">&#9670;&#160;</a></span>m_message</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string gridfire::exceptions::ReactionError::m_message</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ae3531af904d90838ac856cf72cb555f8" name="ae3531af904d90838ac856cf72cb555f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3531af904d90838ac856cf72cb555f8">&#9670;&#160;</a></span>m_reactionID</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string gridfire::exceptions::ReactionError::m_reactionID</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/include/gridfire/exceptions/<a class="el" href="error__reaction_8h.html">error_reaction.h</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"><a class="el" href="namespacegridfire.html">gridfire</a></li><li class="navelem"><a class="el" href="namespacegridfire_1_1exceptions.html">exceptions</a></li><li class="navelem"><a class="el" href="classgridfire_1_1exceptions_1_1ReactionError.html">ReactionError</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
</html>