tboudreaux/GridFire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
ed2c1d58163ab943df0479e8dfcb84862378ae76
GridFire/docs/html/classPyReactionChainPolicy.html

386 lines
21 KiB
HTML
Raw Normal View History

docs(docs): rebuilt for version v0.7.1_rc2
2025-11-28 09:46:00 -05:00
<!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: PyReactionChainPolicy 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('classPyReactionChainPolicy.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="classPyReactionChainPolicy-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">PyReactionChainPolicy Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;py_policy.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PyReactionChainPolicy:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classPyReactionChainPolicy__inherit__graph.svg" width="190" height="124"><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 PyReactionChainPolicy:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classPyReactionChainPolicy__coll__graph.svg" width="190" height="124"><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:a5fd4ff9137e1d76decf7318066d45969" id="r_a5fd4ff9137e1d76decf7318066d45969"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgridfire_1_1reaction_1_1ReactionSet.html">gridfire::reaction::ReactionSet</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPyReactionChainPolicy.html#a5fd4ff9137e1d76decf7318066d45969">get_reactions</a> () const override</td></tr>
<tr class="memdesc:a5fd4ff9137e1d76decf7318066d45969"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the ReactionSet describing this chain. <br /></td></tr>
<tr class="separator:a5fd4ff9137e1d76decf7318066d45969"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16f289efd1d92eead3a3ca6fcfceba4d" id="r_a16f289efd1d92eead3a3ca6fcfceba4d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPyReactionChainPolicy.html#a16f289efd1d92eead3a3ca6fcfceba4d">contains</a> (const std::string &amp;id) const override</td></tr>
<tr class="separator:a16f289efd1d92eead3a3ca6fcfceba4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab30925d8253ecdabb73ea2b116e9c7da" id="r_ab30925d8253ecdabb73ea2b116e9c7da"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPyReactionChainPolicy.html#ab30925d8253ecdabb73ea2b116e9c7da">contains</a> (const <a class="el" href="classgridfire_1_1reaction_1_1Reaction.html">gridfire::reaction::Reaction</a> &amp;reaction) const override</td></tr>
<tr class="separator:ab30925d8253ecdabb73ea2b116e9c7da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b44991bd6a5edebb861e78a26f783cd" id="r_a0b44991bd6a5edebb861e78a26f783cd"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; ReactionChainPolicy &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPyReactionChainPolicy.html#a0b44991bd6a5edebb861e78a26f783cd">clone</a> () const override</td></tr>
<tr class="separator:a0b44991bd6a5edebb861e78a26f783cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af148bf87fea9ebe61de745913a2fd504" id="r_af148bf87fea9ebe61de745913a2fd504"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPyReactionChainPolicy.html#af148bf87fea9ebe61de745913a2fd504">name</a> () const override</td></tr>
<tr class="separator:af148bf87fea9ebe61de745913a2fd504"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42d2f71522e7f13624c2598597f14809" id="r_a42d2f71522e7f13624c2598597f14809"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPyReactionChainPolicy.html#a42d2f71522e7f13624c2598597f14809">hash</a> (uint64_t seed) const override</td></tr>
<tr class="separator:a42d2f71522e7f13624c2598597f14809"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6671a30c99ad7a80edd60bd43a8a233" id="r_ad6671a30c99ad7a80edd60bd43a8a233"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPyReactionChainPolicy.html#ad6671a30c99ad7a80edd60bd43a8a233">operator==</a> (const ReactionChainPolicy &amp;other) const override</td></tr>
<tr class="separator:ad6671a30c99ad7a80edd60bd43a8a233"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e3c5cdd4c1901bedf93168868a759a9" id="r_a8e3c5cdd4c1901bedf93168868a759a9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPyReactionChainPolicy.html#a8e3c5cdd4c1901bedf93168868a759a9">operator!=</a> (const ReactionChainPolicy &amp;other) const override</td></tr>
<tr class="separator:a8e3c5cdd4c1901bedf93168868a759a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgridfire_1_1policy_1_1ReactionChainPolicy"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgridfire_1_1policy_1_1ReactionChainPolicy')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">gridfire::policy::ReactionChainPolicy</a></td></tr>
<tr class="memitem:aa3e6c1e4844fe788aeb08d272070ae13 inherit pub_methods_classgridfire_1_1policy_1_1ReactionChainPolicy" id="r_aa3e6c1e4844fe788aeb08d272070ae13"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#aa3e6c1e4844fe788aeb08d272070ae13">~ReactionChainPolicy</a> ()=default</td></tr>
<tr class="separator:aa3e6c1e4844fe788aeb08d272070ae13 inherit pub_methods_classgridfire_1_1policy_1_1ReactionChainPolicy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30420a3881779c822ab06c0405ea7b28 inherit pub_methods_classgridfire_1_1policy_1_1ReactionChainPolicy" id="r_a30420a3881779c822ab06c0405ea7b28"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#a30420a3881779c822ab06c0405ea7b28">operator==</a> (const <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> &amp;other) const =0</td></tr>
<tr class="separator:a30420a3881779c822ab06c0405ea7b28 inherit pub_methods_classgridfire_1_1policy_1_1ReactionChainPolicy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac19e354a8bcd28f60783b70d8a761030 inherit pub_methods_classgridfire_1_1policy_1_1ReactionChainPolicy" id="r_ac19e354a8bcd28f60783b70d8a761030"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#ac19e354a8bcd28f60783b70d8a761030">operator!=</a> (const <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> &amp;other) const =0</td></tr>
<tr class="separator:ac19e354a8bcd28f60783b70d8a761030 inherit pub_methods_classgridfire_1_1policy_1_1ReactionChainPolicy"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a0b44991bd6a5edebb861e78a26f783cd" name="a0b44991bd6a5edebb861e78a26f783cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b44991bd6a5edebb861e78a26f783cd">&#9670;&#160;</a></span>clone()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unique_ptr&lt; <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">gridfire::policy::ReactionChainPolicy</a> &gt; PyReactionChainPolicy::clone </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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#ac24ff49b7715ad3eefea4bed1bf23686">gridfire::policy::ReactionChainPolicy</a>.</p>
</div>
</div>
<a id="ab30925d8253ecdabb73ea2b116e9c7da" name="ab30925d8253ecdabb73ea2b116e9c7da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab30925d8253ecdabb73ea2b116e9c7da">&#9670;&#160;</a></span>contains() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PyReactionChainPolicy::contains </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classgridfire_1_1reaction_1_1Reaction.html">gridfire::reaction::Reaction</a> &amp;&#160;</td>
<td class="paramname"><em>reaction</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#a68239737ada169238251f1994680fc7e">gridfire::policy::ReactionChainPolicy</a>.</p>
</div>
</div>
<a id="a16f289efd1d92eead3a3ca6fcfceba4d" name="a16f289efd1d92eead3a3ca6fcfceba4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16f289efd1d92eead3a3ca6fcfceba4d">&#9670;&#160;</a></span>contains() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PyReactionChainPolicy::contains </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>id</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#a0c9a42646920ac02c8d1e63dfe6f9461">gridfire::policy::ReactionChainPolicy</a>.</p>
</div>
</div>
<a id="a5fd4ff9137e1d76decf7318066d45969" name="a5fd4ff9137e1d76decf7318066d45969"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5fd4ff9137e1d76decf7318066d45969">&#9670;&#160;</a></span>get_reactions()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classgridfire_1_1reaction_1_1ReactionSet.html">gridfire::reaction::ReactionSet</a> &amp; PyReactionChainPolicy::get_reactions </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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the ReactionSet describing this chain. </p>
<dl class="section return"><dt>Returns</dt><dd>const reaction::ReactionSet&amp; reference to the chain's reactions.</dd></dl>
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="keyword">const</span> reaction::ReactionSet &amp;set = chainPolicy.get_reactions();</div>
<div class="line">std::cout &lt;&lt; <span class="stringliteral">&quot;Chain contains &quot;</span> &lt;&lt; set.size() &lt;&lt; <span class="stringliteral">&quot; reactions\n&quot;</span>;</div>
</div><!-- fragment --></dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classgridfire_1_1exceptions_1_1MissingBaseReactionError.html" title="Exception thrown when a required reaction is missing from the underlying database (e....">gridfire::exceptions::MissingBaseReactionError</a></td><td>may be thrown by concrete implementations at construction time if the required reactions cannot be found in the base reaction set. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#ad8bccf78e7fc99d08387aec5015e8849">gridfire::policy::ReactionChainPolicy</a>.</p>
</div>
</div>
<a id="a42d2f71522e7f13624c2598597f14809" name="a42d2f71522e7f13624c2598597f14809"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42d2f71522e7f13624c2598597f14809">&#9670;&#160;</a></span>hash()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint64_t PyReactionChainPolicy::hash </td>
<td>(</td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>seed</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#a5d1b5640d654f49399145f912e77c19b">gridfire::policy::ReactionChainPolicy</a>.</p>
</div>
</div>
<a id="af148bf87fea9ebe61de745913a2fd504" name="af148bf87fea9ebe61de745913a2fd504"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af148bf87fea9ebe61de745913a2fd504">&#9670;&#160;</a></span>name()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string PyReactionChainPolicy::name </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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#a41758d921a2d7e83f446aa4fec00d598">gridfire::policy::ReactionChainPolicy</a>.</p>
</div>
</div>
<a id="a8e3c5cdd4c1901bedf93168868a759a9" name="a8e3c5cdd4c1901bedf93168868a759a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e3c5cdd4c1901bedf93168868a759a9">&#9670;&#160;</a></span>operator!=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PyReactionChainPolicy::operator!= </td>
<td>(</td>
<td class="paramtype">const ReactionChainPolicy &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad6671a30c99ad7a80edd60bd43a8a233" name="ad6671a30c99ad7a80edd60bd43a8a233"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6671a30c99ad7a80edd60bd43a8a233">&#9670;&#160;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PyReactionChainPolicy::operator== </td>
<td>(</td>
<td class="paramtype">const ReactionChainPolicy &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/python/policy/trampoline/<a class="el" href="py__policy_8h.html">py_policy.h</a></li>
<li>src/python/policy/trampoline/<a class="el" href="py__policy_8cpp.html">py_policy.cpp</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="classPyReactionChainPolicy.html">PyReactionChainPolicy</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>
Reference in New Issue Copy Permalink