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

285 lines
31 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: gridfire::policy::ProtonProtonChainPolicy 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_1policy_1_1ProtonProtonChainPolicy.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_1policy_1_1ProtonProtonChainPolicy-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">gridfire::policy::ProtonProtonChainPolicy Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Proton-Proton Chain Policy.
<a href="classgridfire_1_1policy_1_1ProtonProtonChainPolicy.html#details">More...</a></p>
<p><code>#include &lt;chains.h&gt;</code></p>
<div class="dynheader">
Inheritance diagram for gridfire::policy::ProtonProtonChainPolicy:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1policy_1_1ProtonProtonChainPolicy__inherit__graph.svg" width="223" height="227"><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::policy::ProtonProtonChainPolicy:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1policy_1_1ProtonProtonChainPolicy__coll__graph.svg" width="100%" height="591"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></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:a0700dc96acfae24b242e5556a1bcbf26" id="r_a0700dc96acfae24b242e5556a1bcbf26"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1ProtonProtonChainPolicy.html#a0700dc96acfae24b242e5556a1bcbf26">ProtonProtonChainPolicy</a> ()</td></tr>
<tr class="separator:a0700dc96acfae24b242e5556a1bcbf26"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e818c9a269bc859b01985fea8423ac0" id="r_a2e818c9a269bc859b01985fea8423ac0"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1ProtonProtonChainPolicy.html#a2e818c9a269bc859b01985fea8423ac0">name</a> () const override</td></tr>
<tr class="memdesc:a2e818c9a269bc859b01985fea8423ac0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the name of the <a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html" title="A ReactionChainPolicy composed of multiple child ReactionChainPolicy instances.">MultiReactionChainPolicy</a>. <br /></td></tr>
<tr class="separator:a2e818c9a269bc859b01985fea8423ac0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html">gridfire::policy::MultiReactionChainPolicy</a></td></tr>
<tr class="memitem:ab0e3ba293b5e52d595dfa02db4fcbee7 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy" id="r_ab0e3ba293b5e52d595dfa02db4fcbee7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#ab0e3ba293b5e52d595dfa02db4fcbee7">MultiReactionChainPolicy</a> (std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> &gt; &gt; &amp;&amp;chain_policies)</td></tr>
<tr class="memdesc:ab0e3ba293b5e52d595dfa02db4fcbee7 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a <a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html" title="A ReactionChainPolicy composed of multiple child ReactionChainPolicy instances.">MultiReactionChainPolicy</a> from a vector of <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html" title="Abstract interface encapsulating a set of reactions representing a single chain or pathway.">ReactionChainPolicy</a> instances. <br /></td></tr>
<tr class="separator:ab0e3ba293b5e52d595dfa02db4fcbee7 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeec13e231994234c1ae2b12a0dd7220b inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy" id="r_aeec13e231994234c1ae2b12a0dd7220b"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> &gt; &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#aeec13e231994234c1ae2b12a0dd7220b">get_chain_policies</a> () const</td></tr>
<tr class="memdesc:aeec13e231994234c1ae2b12a0dd7220b inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the vector of child <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html" title="Abstract interface encapsulating a set of reactions representing a single chain or pathway.">ReactionChainPolicy</a> instances. <br /></td></tr>
<tr class="separator:aeec13e231994234c1ae2b12a0dd7220b inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae689a0dfeb36f85ddc6db5a8dc4f630a inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy" id="r_ae689a0dfeb36f85ddc6db5a8dc4f630a"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgridfire_1_1reaction_1_1ReactionSet.html">reaction::ReactionSet</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#ae689a0dfeb36f85ddc6db5a8dc4f630a">get_reactions</a> () const override</td></tr>
<tr class="memdesc:ae689a0dfeb36f85ddc6db5a8dc4f630a inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the combined ReactionSet of all child chain policies. <br /></td></tr>
<tr class="separator:ae689a0dfeb36f85ddc6db5a8dc4f630a inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a792cf0af8e5c365d0332cd585968dae1 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy" id="r_a792cf0af8e5c365d0332cd585968dae1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#a792cf0af8e5c365d0332cd585968dae1">contains</a> (const std::string &amp;id) const override</td></tr>
<tr class="memdesc:a792cf0af8e5c365d0332cd585968dae1 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the <a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html" title="A ReactionChainPolicy composed of multiple child ReactionChainPolicy instances.">MultiReactionChainPolicy</a> contains a reaction by ID. <br /></td></tr>
<tr class="separator:a792cf0af8e5c365d0332cd585968dae1 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a864a00097e80db7b0f3838d696aa9f5d inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy" id="r_a864a00097e80db7b0f3838d696aa9f5d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#a864a00097e80db7b0f3838d696aa9f5d">contains</a> (const <a class="el" href="classgridfire_1_1reaction_1_1Reaction.html">reaction::Reaction</a> &amp;reaction) const override</td></tr>
<tr class="memdesc:a864a00097e80db7b0f3838d696aa9f5d inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if the <a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html" title="A ReactionChainPolicy composed of multiple child ReactionChainPolicy instances.">MultiReactionChainPolicy</a> contains a specific reaction. <br /></td></tr>
<tr class="separator:a864a00097e80db7b0f3838d696aa9f5d inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3bbbf21164211a01c5398a0ee281bb2 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy" id="r_ab3bbbf21164211a01c5398a0ee281bb2"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#ab3bbbf21164211a01c5398a0ee281bb2">clone</a> () const override</td></tr>
<tr class="memdesc:ab3bbbf21164211a01c5398a0ee281bb2 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a deep copy of the <a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html" title="A ReactionChainPolicy composed of multiple child ReactionChainPolicy instances.">MultiReactionChainPolicy</a>. <br /></td></tr>
<tr class="separator:ab3bbbf21164211a01c5398a0ee281bb2 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5ac6534ec96cfcdefcad2f9694efd36 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy" id="r_ae5ac6534ec96cfcdefcad2f9694efd36"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#ae5ac6534ec96cfcdefcad2f9694efd36">hash</a> (uint64_t seed) const override</td></tr>
<tr class="memdesc:ae5ac6534ec96cfcdefcad2f9694efd36 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computes a hash value for the <a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html" title="A ReactionChainPolicy composed of multiple child ReactionChainPolicy instances.">MultiReactionChainPolicy</a>. <br /></td></tr>
<tr class="separator:ae5ac6534ec96cfcdefcad2f9694efd36 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc3ed7c255b3e6c06e292aee8ef7f46d inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy" id="r_abc3ed7c255b3e6c06e292aee8ef7f46d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#abc3ed7c255b3e6c06e292aee8ef7f46d">operator==</a> (const <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> &amp;other) const override</td></tr>
<tr class="memdesc:abc3ed7c255b3e6c06e292aee8ef7f46d inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equality comparison operator. <br /></td></tr>
<tr class="separator:abc3ed7c255b3e6c06e292aee8ef7f46d inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa36844fe4417617175d31124e541da50 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy" id="r_aa36844fe4417617175d31124e541da50"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#aa36844fe4417617175d31124e541da50">operator!=</a> (const <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> &amp;other) const override</td></tr>
<tr class="memdesc:aa36844fe4417617175d31124e541da50 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inequality comparison operator. <br /></td></tr>
<tr class="separator:aa36844fe4417617175d31124e541da50 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84fcdc2adab96284d850f8dd43315278 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy" id="r_a84fcdc2adab96284d850f8dd43315278"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#a84fcdc2adab96284d850f8dd43315278">size</a> () const</td></tr>
<tr class="memdesc:a84fcdc2adab96284d850f8dd43315278 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of child <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html" title="Abstract interface encapsulating a set of reactions representing a single chain or pathway.">ReactionChainPolicy</a> instances. <br /></td></tr>
<tr class="separator:a84fcdc2adab96284d850f8dd43315278 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2317c6351bb1fc07ff0a27cd358b4f73 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy" id="r_a2317c6351bb1fc07ff0a27cd358b4f73"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#a2317c6351bb1fc07ff0a27cd358b4f73">begin</a> ()</td></tr>
<tr class="memdesc:a2317c6351bb1fc07ff0a27cd358b4f73 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns iterator to the beginning of the child <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html" title="Abstract interface encapsulating a set of reactions representing a single chain or pathway.">ReactionChainPolicy</a> instances. <br /></td></tr>
<tr class="separator:a2317c6351bb1fc07ff0a27cd358b4f73 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b340b7bdb8cf9e32f004074b1901815 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy" id="r_a6b340b7bdb8cf9e32f004074b1901815"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#a6b340b7bdb8cf9e32f004074b1901815">begin</a> () const</td></tr>
<tr class="memdesc:a6b340b7bdb8cf9e32f004074b1901815 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns const iterator to the beginning of the child <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html" title="Abstract interface encapsulating a set of reactions representing a single chain or pathway.">ReactionChainPolicy</a> instances. <br /></td></tr>
<tr class="separator:a6b340b7bdb8cf9e32f004074b1901815 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa71cb8b9c72af7047c4ae54b8c33915 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy" id="r_aaa71cb8b9c72af7047c4ae54b8c33915"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#aaa71cb8b9c72af7047c4ae54b8c33915">end</a> ()</td></tr>
<tr class="memdesc:aaa71cb8b9c72af7047c4ae54b8c33915 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns iterator to the end of the child <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html" title="Abstract interface encapsulating a set of reactions representing a single chain or pathway.">ReactionChainPolicy</a> instances. <br /></td></tr>
<tr class="separator:aaa71cb8b9c72af7047c4ae54b8c33915 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f2f648e161d1935c27729bcd6054187 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy" id="r_a8f2f648e161d1935c27729bcd6054187"><td class="memItemLeft" align="right" valign="top">auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#a8f2f648e161d1935c27729bcd6054187">end</a> () const</td></tr>
<tr class="memdesc:a8f2f648e161d1935c27729bcd6054187 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns const iterator to the end of the child <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html" title="Abstract interface encapsulating a set of reactions representing a single chain or pathway.">ReactionChainPolicy</a> instances. <br /></td></tr>
<tr class="separator:a8f2f648e161d1935c27729bcd6054187 inherit pub_methods_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><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>
</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:a43d461d976f9cff765db92c05765d0a3" id="r_a43d461d976f9cff765db92c05765d0a3"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1ProtonProtonChainPolicy.html#a43d461d976f9cff765db92c05765d0a3">m_chain_policies</a></td></tr>
<tr class="separator:a43d461d976f9cff765db92c05765d0a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_attribs_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classgridfire_1_1policy_1_1MultiReactionChainPolicy')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html">gridfire::policy::MultiReactionChainPolicy</a></td></tr>
<tr class="memitem:a8ef92bf3b66d77f8141bb6010e909e99 inherit pro_attribs_classgridfire_1_1policy_1_1MultiReactionChainPolicy" id="r_a8ef92bf3b66d77f8141bb6010e909e99"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#a8ef92bf3b66d77f8141bb6010e909e99">m_chain_policies</a> {}</td></tr>
<tr class="memdesc:a8ef92bf3b66d77f8141bb6010e909e99 inherit pro_attribs_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="mdescLeft">&#160;</td><td class="mdescRight">Child chain policies. <br /></td></tr>
<tr class="separator:a8ef92bf3b66d77f8141bb6010e909e99 inherit pro_attribs_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adaf3fa4b8cd0fde5994f54494701c32d inherit pro_attribs_classgridfire_1_1policy_1_1MultiReactionChainPolicy" id="r_adaf3fa4b8cd0fde5994f54494701c32d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1reaction_1_1ReactionSet.html">reaction::ReactionSet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#adaf3fa4b8cd0fde5994f54494701c32d">m_reactions</a></td></tr>
<tr class="memdesc:adaf3fa4b8cd0fde5994f54494701c32d inherit pro_attribs_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><td class="mdescLeft">&#160;</td><td class="mdescRight">Combined reactions from all child policies. <br /></td></tr>
<tr class="separator:adaf3fa4b8cd0fde5994f54494701c32d inherit pro_attribs_classgridfire_1_1policy_1_1MultiReactionChainPolicy"><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>Proton-Proton Chain Policy. </p>
<p>This class implements the overall Proton-Proton chain of nuclear reactions, combining the Proton-Proton I, II, and III chains. Enforcing this chain in the policy will ensure that all the Proton-Proton reactions are included in the network.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classgridfire_1_1policy_1_1ProtonProtonIChainPolicy.html" title="Proton-Proton I Chain Policy.">ProtonProtonIChainPolicy</a> </dd>
<dd>
<a class="el" href="classgridfire_1_1policy_1_1ProtonProtonIIChainPolicy.html" title="Proton-Proton II Chain Policy.">ProtonProtonIIChainPolicy</a> </dd>
<dd>
<a class="el" href="classgridfire_1_1policy_1_1ProtonProtonIIIChainPolicy.html" title="Proton-Proton III Chain Policy.">ProtonProtonIIIChainPolicy</a> </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0700dc96acfae24b242e5556a1bcbf26" name="a0700dc96acfae24b242e5556a1bcbf26"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0700dc96acfae24b242e5556a1bcbf26">&#9670;&#160;</a></span>ProtonProtonChainPolicy()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gridfire::policy::ProtonProtonChainPolicy::ProtonProtonChainPolicy </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2e818c9a269bc859b01985fea8423ac0" name="a2e818c9a269bc859b01985fea8423ac0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e818c9a269bc859b01985fea8423ac0">&#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 gridfire::policy::ProtonProtonChainPolicy::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>Returns the name of the <a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html" title="A ReactionChainPolicy composed of multiple child ReactionChainPolicy instances.">MultiReactionChainPolicy</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>std::string the name of the policy.</dd></dl>
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line">std::string n = multi.name();</div>
<div class="line">std::cout &lt;&lt; <span class="stringliteral">&quot;Using policy: &quot;</span> &lt;&lt; n &lt;&lt; std::endl;</div>
</div><!-- fragment --> </dd></dl>
<p>Reimplemented from <a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#ac21f837d0d452d32588451f48d5482e6">gridfire::policy::MultiReactionChainPolicy</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a43d461d976f9cff765db92c05765d0a3" name="a43d461d976f9cff765db92c05765d0a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43d461d976f9cff765db92c05765d0a3">&#9670;&#160;</a></span>m_chain_policies</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;std::unique_ptr&lt;<a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a>&gt; &gt; gridfire::policy::ProtonProtonChainPolicy::m_chain_policies</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 files:<ul>
<li>src/include/gridfire/policy/<a class="el" href="chains_8h.html">chains.h</a></li>
<li>src/lib/policy/<a class="el" href="chains_8cpp.html">chains.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="namespacegridfire.html">gridfire</a></li><li class="navelem"><a class="el" href="namespacegridfire_1_1policy.html">policy</a></li><li class="navelem"><a class="el" href="classgridfire_1_1policy_1_1ProtonProtonChainPolicy.html">ProtonProtonChainPolicy</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