765 lines
52 KiB
HTML
765 lines
52 KiB
HTML
|
<!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::MultiReactionChainPolicy 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"> 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&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&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&dn=expat.txt MIT */
|
||
|
|
$(document).ready(function(){initNavTree('classgridfire_1_1policy_1_1MultiReactionChainPolicy.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> |
|
||
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
||
|
|
<a href="classgridfire_1_1policy_1_1MultiReactionChainPolicy-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle"><div class="title">gridfire::policy::MultiReactionChainPolicy Class Reference</div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>A <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> composed of multiple 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.
|
||
|
|
<a href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#details">More...</a></p>
|
||
|
|
|
||
|
|
<p><code>#include <policy_logical.h></code></p>
|
||
|
|
<div class="dynheader">
|
||
|
|
Inheritance diagram for gridfire::policy::MultiReactionChainPolicy:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1policy_1_1MultiReactionChainPolicy__inherit__graph.svg" width="100%" height="482"><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>
|
||
|
|
<div class="dynheader">
|
||
|
|
Collaboration diagram for gridfire::policy::MultiReactionChainPolicy:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classgridfire_1_1policy_1_1MultiReactionChainPolicy__coll__graph.svg" width="100%" height="570"><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:ab0e3ba293b5e52d595dfa02db4fcbee7" id="r_ab0e3ba293b5e52d595dfa02db4fcbee7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#ab0e3ba293b5e52d595dfa02db4fcbee7">MultiReactionChainPolicy</a> (std::vector< std::unique_ptr< <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> > > &&chain_policies)</td></tr>
|
||
|
|
<tr class="memdesc:ab0e3ba293b5e52d595dfa02db4fcbee7"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aeec13e231994234c1ae2b12a0dd7220b" id="r_aeec13e231994234c1ae2b12a0dd7220b"><td class="memItemLeft" align="right" valign="top">const std::vector< std::unique_ptr< <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> > > & </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ae689a0dfeb36f85ddc6db5a8dc4f630a" id="r_ae689a0dfeb36f85ddc6db5a8dc4f630a"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgridfire_1_1reaction_1_1ReactionSet.html">reaction::ReactionSet</a> & </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"><td class="mdescLeft"> </td><td class="mdescRight">Returns the combined ReactionSet of all child chain policies. <br /></td></tr>
|
||
|
|
<tr class="separator:ae689a0dfeb36f85ddc6db5a8dc4f630a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a792cf0af8e5c365d0332cd585968dae1" id="r_a792cf0af8e5c365d0332cd585968dae1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#a792cf0af8e5c365d0332cd585968dae1">contains</a> (const std::string &id) const override</td></tr>
|
||
|
|
<tr class="memdesc:a792cf0af8e5c365d0332cd585968dae1"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a864a00097e80db7b0f3838d696aa9f5d" id="r_a864a00097e80db7b0f3838d696aa9f5d"><td class="memItemLeft" align="right" valign="top">bool </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> &reaction) const override</td></tr>
|
||
|
|
<tr class="memdesc:a864a00097e80db7b0f3838d696aa9f5d"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ab3bbbf21164211a01c5398a0ee281bb2" id="r_ab3bbbf21164211a01c5398a0ee281bb2"><td class="memItemLeft" align="right" valign="top">std::unique_ptr< <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> > </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ac21f837d0d452d32588451f48d5482e6" id="r_ac21f837d0d452d32588451f48d5482e6"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#ac21f837d0d452d32588451f48d5482e6">name</a> () const override</td></tr>
|
||
|
|
<tr class="memdesc:ac21f837d0d452d32588451f48d5482e6"><td class="mdescLeft"> </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:ac21f837d0d452d32588451f48d5482e6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ae5ac6534ec96cfcdefcad2f9694efd36" id="r_ae5ac6534ec96cfcdefcad2f9694efd36"><td class="memItemLeft" align="right" valign="top">uint64_t </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:abc3ed7c255b3e6c06e292aee8ef7f46d" id="r_abc3ed7c255b3e6c06e292aee8ef7f46d"><td class="memItemLeft" align="right" valign="top">bool </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> &other) const override</td></tr>
|
||
|
|
<tr class="memdesc:abc3ed7c255b3e6c06e292aee8ef7f46d"><td class="mdescLeft"> </td><td class="mdescRight">Equality comparison operator. <br /></td></tr>
|
||
|
|
<tr class="separator:abc3ed7c255b3e6c06e292aee8ef7f46d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa36844fe4417617175d31124e541da50" id="r_aa36844fe4417617175d31124e541da50"><td class="memItemLeft" align="right" valign="top">bool </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> &other) const override</td></tr>
|
||
|
|
<tr class="memdesc:aa36844fe4417617175d31124e541da50"><td class="mdescLeft"> </td><td class="mdescRight">Inequality comparison operator. <br /></td></tr>
|
||
|
|
<tr class="separator:aa36844fe4417617175d31124e541da50"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a84fcdc2adab96284d850f8dd43315278" id="r_a84fcdc2adab96284d850f8dd43315278"><td class="memItemLeft" align="right" valign="top">size_t </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a2317c6351bb1fc07ff0a27cd358b4f73" id="r_a2317c6351bb1fc07ff0a27cd358b4f73"><td class="memItemLeft" align="right" valign="top">auto </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6b340b7bdb8cf9e32f004074b1901815" id="r_a6b340b7bdb8cf9e32f004074b1901815"><td class="memItemLeft" align="right" valign="top">auto </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aaa71cb8b9c72af7047c4ae54b8c33915" id="r_aaa71cb8b9c72af7047c4ae54b8c33915"><td class="memItemLeft" align="right" valign="top">auto </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a8f2f648e161d1935c27729bcd6054187" id="r_a8f2f648e161d1935c27729bcd6054187"><td class="memItemLeft" align="right" valign="top">auto </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"><td class="mdescLeft"> </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"><td class="memSeparator" colspan="2"> </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="-"/> 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 </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"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
|
||
|
|
Protected Attributes</h2></td></tr>
|
||
|
|
<tr class="memitem:a8ef92bf3b66d77f8141bb6010e909e99" id="r_a8ef92bf3b66d77f8141bb6010e909e99"><td class="memItemLeft" align="right" valign="top">std::vector< std::unique_ptr< <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> > > </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"><td class="mdescLeft"> </td><td class="mdescRight">Child chain policies. <br /></td></tr>
|
||
|
|
<tr class="separator:a8ef92bf3b66d77f8141bb6010e909e99"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:adaf3fa4b8cd0fde5994f54494701c32d" id="r_adaf3fa4b8cd0fde5994f54494701c32d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgridfire_1_1reaction_1_1ReactionSet.html">reaction::ReactionSet</a> </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"><td class="mdescLeft"> </td><td class="mdescRight">Combined reactions from all child policies. <br /></td></tr>
|
||
|
|
<tr class="separator:adaf3fa4b8cd0fde5994f54494701c32d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>A <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> composed of multiple 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. </p>
|
||
|
|
<p>Useful for policies that represent a union of several reaction chains (for example the <code>LowMassMainSequenceReactionChainPolicy</code> composes the proton-proton and CNO chains).</p>
|
||
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line">LowMassMainSequenceReactionChainPolicy multi;</div>
|
||
|
|
<div class="line"><span class="keyword">const</span> <span class="keyword">auto</span> &chains = multi.get_chain_policies();</div>
|
||
|
|
<div class="line"><span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span> &ch : chains) { std::cout << ch->get_reactions().size() << <span class="stringliteral">" reactions\n"</span>; }</div>
|
||
|
|
</div><!-- fragment --> </dd></dl>
|
||
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||
|
|
<a id="ab0e3ba293b5e52d595dfa02db4fcbee7" name="ab0e3ba293b5e52d595dfa02db4fcbee7"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab0e3ba293b5e52d595dfa02db4fcbee7">◆ </a></span>MultiReactionChainPolicy()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">gridfire::policy::MultiReactionChainPolicy::MultiReactionChainPolicy </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">std::vector< std::unique_ptr< <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> > > && </td>
|
||
|
|
<td class="paramname"><em>chain_policies</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>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. </p>
|
||
|
|
<p>The provided chain policies are moved into the new <a class="el" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html" title="A ReactionChainPolicy composed of multiple child ReactionChainPolicy instances.">MultiReactionChainPolicy</a> instance.</p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">chain_policies</td><td>vector of unique_ptr to <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.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line">std::vector<std::unique_ptr<ReactionChainPolicy>> chains;</div>
|
||
|
|
<div class="line">chains.push_back(std::make_unique<ProtonProtonChainPolicy>());</div>
|
||
|
|
<div class="line">chains.push_back(std::make_unique<CNOChainPolicy>());</div>
|
||
|
|
<div class="line"><a class="code hl_class" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html">MultiReactionChainPolicy</a> multi(std::move(chains));</div>
|
||
|
|
<div class="ttc" id="aclassgridfire_1_1policy_1_1MultiReactionChainPolicy_html"><div class="ttname"><a href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html">gridfire::policy::MultiReactionChainPolicy</a></div><div class="ttdoc">A ReactionChainPolicy composed of multiple child ReactionChainPolicy instances.</div><div class="ttdef"><b>Definition</b> policy_logical.h:23</div></div>
|
||
|
|
</div><!-- fragment --> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a id="a2317c6351bb1fc07ff0a27cd358b4f73" name="a2317c6351bb1fc07ff0a27cd358b4f73"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2317c6351bb1fc07ff0a27cd358b4f73">◆ </a></span>begin() <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">auto gridfire::policy::MultiReactionChainPolicy::begin </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></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>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. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>iterator to the beginning.</dd></dl>
|
||
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="keywordflow">for</span> (<span class="keyword">auto</span> it = multi.begin(); it != multi.end(); ++it) {</div>
|
||
|
|
<div class="line"> std::cout << (*it)->name() << std::endl;</div>
|
||
|
|
<div class="line">}</div>
|
||
|
|
</div><!-- fragment --> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a6b340b7bdb8cf9e32f004074b1901815" name="a6b340b7bdb8cf9e32f004074b1901815"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6b340b7bdb8cf9e32f004074b1901815">◆ </a></span>begin() <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">auto gridfire::policy::MultiReactionChainPolicy::begin </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 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. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>const iterator to the beginning.</dd></dl>
|
||
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="keywordflow">for</span> (<span class="keyword">auto</span> it = multi.begin(); it != multi.end(); ++it) {</div>
|
||
|
|
<div class="line"> std::cout << (*it)->name() << std::endl;</div>
|
||
|
|
<div class="line">}</div>
|
||
|
|
</div><!-- fragment --> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ab3bbbf21164211a01c5398a0ee281bb2" name="ab3bbbf21164211a01c5398a0ee281bb2"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab3bbbf21164211a01c5398a0ee281bb2">◆ </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< <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> > gridfire::policy::MultiReactionChainPolicy::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>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>. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>std::unique_ptr<ReactionChainPolicy> unique pointer to the cloned instance.</dd></dl>
|
||
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line">std::unique_ptr<ReactionChainPolicy> <a class="code hl_function" href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#ab3bbbf21164211a01c5398a0ee281bb2">clone</a> = multi.clone();</div>
|
||
|
|
<div class="ttc" id="aclassgridfire_1_1policy_1_1MultiReactionChainPolicy_html_ab3bbbf21164211a01c5398a0ee281bb2"><div class="ttname"><a href="classgridfire_1_1policy_1_1MultiReactionChainPolicy.html#ab3bbbf21164211a01c5398a0ee281bb2">gridfire::policy::MultiReactionChainPolicy::clone</a></div><div class="ttdeci">std::unique_ptr< ReactionChainPolicy > clone() const override</div><div class="ttdoc">Creates a deep copy of the MultiReactionChainPolicy.</div><div class="ttdef"><b>Definition</b> policy_logical.cpp:32</div></div>
|
||
|
|
</div><!-- fragment --> </dd></dl>
|
||
|
|
|
||
|
|
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#ac24ff49b7715ad3eefea4bed1bf23686">gridfire::policy::ReactionChainPolicy</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a864a00097e80db7b0f3838d696aa9f5d" name="a864a00097e80db7b0f3838d696aa9f5d"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a864a00097e80db7b0f3838d696aa9f5d">◆ </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 gridfire::policy::MultiReactionChainPolicy::contains </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classgridfire_1_1reaction_1_1Reaction.html">reaction::Reaction</a> & </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>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. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">reaction</td><td>the Reaction to check for. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>true if the reaction is present in the combined ReactionSet, false otherwise.</dd></dl>
|
||
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><a class="code hl_class" href="classgridfire_1_1reaction_1_1Reaction.html">reaction::Reaction</a> r = ...; <span class="comment">// obtain a Reaction instance</span></div>
|
||
|
|
<div class="line"><span class="keywordtype">bool</span> has_reaction = multi.contains(r);</div>
|
||
|
|
<div class="ttc" id="aclassgridfire_1_1reaction_1_1Reaction_html"><div class="ttname"><a href="classgridfire_1_1reaction_1_1Reaction.html">gridfire::reaction::Reaction</a></div><div class="ttdoc">Represents a single nuclear reaction from a specific data source.</div><div class="ttdef"><b>Definition</b> reaction.h:98</div></div>
|
||
|
|
</div><!-- fragment --> </dd></dl>
|
||
|
|
|
||
|
|
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#a68239737ada169238251f1994680fc7e">gridfire::policy::ReactionChainPolicy</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a792cf0af8e5c365d0332cd585968dae1" name="a792cf0af8e5c365d0332cd585968dae1"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a792cf0af8e5c365d0332cd585968dae1">◆ </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 gridfire::policy::MultiReactionChainPolicy::contains </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const std::string & </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>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. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">id</td><td>the reaction ID to check for. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>true if the reaction ID is present in the combined ReactionSet, false otherwise.</dd></dl>
|
||
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="keywordtype">bool</span> has_pp = multi.contains(<span class="stringliteral">"p(p,e+)d"</span>);</div>
|
||
|
|
</div><!-- fragment --> </dd></dl>
|
||
|
|
|
||
|
|
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#a0c9a42646920ac02c8d1e63dfe6f9461">gridfire::policy::ReactionChainPolicy</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aaa71cb8b9c72af7047c4ae54b8c33915" name="aaa71cb8b9c72af7047c4ae54b8c33915"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaa71cb8b9c72af7047c4ae54b8c33915">◆ </a></span>end() <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">auto gridfire::policy::MultiReactionChainPolicy::end </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></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>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. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>iterator to the end.</dd></dl>
|
||
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="keywordflow">for</span> (<span class="keyword">auto</span> it = multi.begin(); it != multi.end(); ++it) {</div>
|
||
|
|
<div class="line"> std::cout << (*it)->name() << std::endl;</div>
|
||
|
|
<div class="line">}</div>
|
||
|
|
</div><!-- fragment --> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a8f2f648e161d1935c27729bcd6054187" name="a8f2f648e161d1935c27729bcd6054187"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8f2f648e161d1935c27729bcd6054187">◆ </a></span>end() <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">auto gridfire::policy::MultiReactionChainPolicy::end </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 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. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>const iterator to the end.</dd></dl>
|
||
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="keywordflow">for</span> (<span class="keyword">auto</span> it = multi.begin(); it != multi.end(); ++it) {</div>
|
||
|
|
<div class="line"> std::cout << (*it)->name() << std::endl;</div>
|
||
|
|
<div class="line">}</div>
|
||
|
|
</div><!-- fragment --> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aeec13e231994234c1ae2b12a0dd7220b" name="aeec13e231994234c1ae2b12a0dd7220b"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeec13e231994234c1ae2b12a0dd7220b">◆ </a></span>get_chain_policies()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">const std::vector< std::unique_ptr< <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> > > & gridfire::policy::MultiReactionChainPolicy::get_chain_policies </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>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. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>const std::vector<std::unique_ptr<ReactionChainPolicy>>& reference to the child chain policies.</dd></dl>
|
||
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="keyword">const</span> <span class="keyword">auto</span> &chains = multi.get_chain_policies();</div>
|
||
|
|
<div class="line"><span class="keywordflow">for</span> (<span class="keyword">const</span> <span class="keyword">auto</span> &ch : chains) { std::cout << ch->get_reactions().size() << <span class="stringliteral">" reactions\n"</span>; }</div>
|
||
|
|
</div><!-- fragment --> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ae689a0dfeb36f85ddc6db5a8dc4f630a" name="ae689a0dfeb36f85ddc6db5a8dc4f630a"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae689a0dfeb36f85ddc6db5a8dc4f630a">◆ </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">reaction::ReactionSet</a> & gridfire::policy::MultiReactionChainPolicy::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 combined ReactionSet of all child chain policies. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>const <a class="el" href="classgridfire_1_1reaction_1_1ReactionSet.html">reaction::ReactionSet</a>& reference to the combined reactions.</dd></dl>
|
||
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="keyword">const</span> <span class="keyword">auto</span> &reactions = multi.get_reactions();</div>
|
||
|
|
<div class="line">std::cout << <span class="stringliteral">"Multi chain contains "</span> << reactions.size() << <span class="stringliteral">" reactions\n"</span>;</div>
|
||
|
|
</div><!-- fragment --> </dd></dl>
|
||
|
|
|
||
|
|
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#ad8bccf78e7fc99d08387aec5015e8849">gridfire::policy::ReactionChainPolicy</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ae5ac6534ec96cfcdefcad2f9694efd36" name="ae5ac6534ec96cfcdefcad2f9694efd36"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae5ac6534ec96cfcdefcad2f9694efd36">◆ </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 gridfire::policy::MultiReactionChainPolicy::hash </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint64_t </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>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>. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">seed</td><td>the seed value for the hash computation. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>uint64_t the computed hash value.</dd></dl>
|
||
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line">uint64_t h = multi.hash(0);</div>
|
||
|
|
<div class="line">std::cout << <span class="stringliteral">"Policy hash: "</span> << h << std::endl;</div>
|
||
|
|
</div><!-- fragment --> </dd></dl>
|
||
|
|
|
||
|
|
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#a5d1b5640d654f49399145f912e77c19b">gridfire::policy::ReactionChainPolicy</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ac21f837d0d452d32588451f48d5482e6" name="ac21f837d0d452d32588451f48d5482e6"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac21f837d0d452d32588451f48d5482e6">◆ </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::MultiReactionChainPolicy::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 << <span class="stringliteral">"Using policy: "</span> << n << std::endl;</div>
|
||
|
|
</div><!-- fragment --> </dd></dl>
|
||
|
|
|
||
|
|
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#a41758d921a2d7e83f446aa4fec00d598">gridfire::policy::ReactionChainPolicy</a>.</p>
|
||
|
|
|
||
|
|
<p>Reimplemented in <a class="el" href="classgridfire_1_1policy_1_1ProtonProtonChainPolicy.html#a2e818c9a269bc859b01985fea8423ac0">gridfire::policy::ProtonProtonChainPolicy</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aa36844fe4417617175d31124e541da50" name="aa36844fe4417617175d31124e541da50"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa36844fe4417617175d31124e541da50">◆ </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 gridfire::policy::MultiReactionChainPolicy::operator!= </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> & </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 class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Inequality comparison operator. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">other</td><td>the other <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> to compare against. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>true if the policies are not equal, false otherwise.</dd></dl>
|
||
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="keywordtype">bool</span> not_equal = (multi1 != multi2);</div>
|
||
|
|
</div><!-- fragment --> </dd></dl>
|
||
|
|
|
||
|
|
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#ac19e354a8bcd28f60783b70d8a761030">gridfire::policy::ReactionChainPolicy</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="abc3ed7c255b3e6c06e292aee8ef7f46d" name="abc3ed7c255b3e6c06e292aee8ef7f46d"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abc3ed7c255b3e6c06e292aee8ef7f46d">◆ </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 gridfire::policy::MultiReactionChainPolicy::operator== </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a> & </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 class="mlabel">virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Equality comparison operator. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">other</td><td>the other <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> to compare against. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>true if the policies are equal, false otherwise.</dd></dl>
|
||
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="keywordtype">bool</span> equal = (multi1 == multi2);</div>
|
||
|
|
</div><!-- fragment --> </dd></dl>
|
||
|
|
|
||
|
|
<p>Implements <a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html#a30420a3881779c822ab06c0405ea7b28">gridfire::policy::ReactionChainPolicy</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a84fcdc2adab96284d850f8dd43315278" name="a84fcdc2adab96284d850f8dd43315278"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a84fcdc2adab96284d850f8dd43315278">◆ </a></span>size()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">size_t gridfire::policy::MultiReactionChainPolicy::size </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td> const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>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. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>size_t the number of child chain policies.</dd></dl>
|
||
|
|
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="keywordtype">size_t</span> n = multi.size();</div>
|
||
|
|
<div class="line">std::cout << <span class="stringliteral">"Multi chain has "</span> << n << <span class="stringliteral">" child policies\n"</span>;</div>
|
||
|
|
</div><!-- fragment --> </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
||
|
|
<a id="a8ef92bf3b66d77f8141bb6010e909e99" name="a8ef92bf3b66d77f8141bb6010e909e99"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8ef92bf3b66d77f8141bb6010e909e99">◆ </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<std::unique_ptr<<a class="el" href="classgridfire_1_1policy_1_1ReactionChainPolicy.html">ReactionChainPolicy</a>> > gridfire::policy::MultiReactionChainPolicy::m_chain_policies {}</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Child chain policies. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="adaf3fa4b8cd0fde5994f54494701c32d" name="adaf3fa4b8cd0fde5994f54494701c32d"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adaf3fa4b8cd0fde5994f54494701c32d">◆ </a></span>m_reactions</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="classgridfire_1_1reaction_1_1ReactionSet.html">reaction::ReactionSet</a> gridfire::policy::MultiReactionChainPolicy::m_reactions</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Combined reactions from all child policies. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
||
|
|
<li>src/include/gridfire/policy/<a class="el" href="policy__logical_8h.html">policy_logical.h</a></li>
|
||
|
|
<li>src/lib/policy/<a class="el" href="policy__logical_8cpp.html">policy_logical.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_1MultiReactionChainPolicy.html">MultiReactionChainPolicy</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>
|